From 2425788a9dccc13f6e33c06425cc3b5007e6d8e0 Mon Sep 17 00:00:00 2001 From: Todd Viegut Date: Tue, 29 Oct 2024 12:48:44 -0500 Subject: [PATCH 1/4] Update core-concepts.md --- docs/core-concepts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core-concepts.md b/docs/core-concepts.md index 0270fb4..5730176 100644 --- a/docs/core-concepts.md +++ b/docs/core-concepts.md @@ -68,7 +68,7 @@ In the CIM UML, each class name, such as ACLineSegment, is qualified by a namesp !!! note - By convention, namespaces most commonly signify who the issuing authority of whatever class representation follows. The CIM UML model itself is open source and is made available under the Apache 2.0 open source license. Standards Development Organizations (SDOs) such as the [International Electrotechnical Commission](https://en.wikipedia.org/wiki/International_Electrotechnical_Commission) (IEC) or the [European Network of Transmission System Operators for Electricity](https://www.entsoe.eu/) (ENTSO-E) may freely utilize the CIM under its licensing terms. The IEC, for instance, utilized the CIM as the foundation for the development of International Standards to support Transmission and Distribution operations and various backoffice functions. In practical applications, CIM standards published by the IEC are often used alongside project and vendor-specific extensions. Each of these may have an independent author. Separate namespaces are used to prevent name conflicts between them. + By convention, namespaces most commonly signify who the issuing authority of whatever class representation follows. The CIM UML model itself is open source and is made available under the Apache 2.0 open source license. Standards Development Organizations (SDOs) such as the [International Electrotechnical Commission](https://en.wikipedia.org/wiki/International_Electrotechnical_Commission) (IEC) or the [European Network of Transmission System Operators for Electricity](https://www.entsoe.eu/) (ENTSO-E) may freely utilize the CIM under its licensing terms. The IEC, for instance, utilizes the CIM as the foundation for the development of International Standards to support Transmission and Distribution operations and various backoffice functions. In practical applications, CIM standards published by the IEC are often used alongside project and vendor-specific extensions. Each of these may have an independent author. Separate namespaces are used to prevent name conflicts between them. Namespaces don't carry much information in themselves. A namespace can be any string but it is common and recommended to use an HTTP URI (e.g. `http://authority/...`) because it translates well to conventions followed in generated schemas (e.g. XML Schema) and it identifies the issuing authority. This is the convention commonly followed by many SDOs. For example, someone can easily find more information on the issuing authoriy by using something like [whois](https://www.whois.com/whois). From 657957d300e88bf05c39786d56022d6021a339f0 Mon Sep 17 00:00:00 2001 From: Todd Viegut Date: Fri, 8 Nov 2024 09:15:44 -0600 Subject: [PATCH 2/4] Update issue templates --- .github/ISSUE_TEMPLATE/cimtool-bug-report.md | 36 ++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/cimtool-bug-report.md diff --git a/.github/ISSUE_TEMPLATE/cimtool-bug-report.md b/.github/ISSUE_TEMPLATE/cimtool-bug-report.md new file mode 100644 index 0000000..239a368 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cimtool-bug-report.md @@ -0,0 +1,36 @@ +--- +name: CIMTool Bug Report +about: Create a report to help us improve CIMTool +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. This should include a high level description of what you were trying to do that produced the issue. (e.g. "While creating a new profile I selected the + +** CIMTool release** +The exact release of CIMTool you were using (e.g. CIMTool 2.0.1) + +** CIM Schema version ** +If relevant to the bug you are reporting, please include the exact name of the schema(s) you are using for your profiling. For example: +- iec61970cim17v38_iec61968cim13v13b_iec62325cim03v17a_CIM100.2.eap +- iec61970cim17v40-cimtool.xmi +- other... + +**To Reproduce** +Depending on the nature of the bug, in some cases it can be helpful to provide detailed steps to reproduce the behavior. If you assess this is the case please include here such as: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. From 27c0aecbe00120f0f45deba289264dc0d86a849a Mon Sep 17 00:00:00 2001 From: Todd Viegut Date: Fri, 8 Nov 2024 09:19:16 -0600 Subject: [PATCH 3/4] Update issue templates --- .../cimtool-feature-or-enhancement-request.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/cimtool-feature-or-enhancement-request.md diff --git a/.github/ISSUE_TEMPLATE/cimtool-feature-or-enhancement-request.md b/.github/ISSUE_TEMPLATE/cimtool-feature-or-enhancement-request.md new file mode 100644 index 0000000..ca4a4d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cimtool-feature-or-enhancement-request.md @@ -0,0 +1,20 @@ +--- +name: CIMTool Feature or Enhancement Request +about: Suggest an idea for CIMTool +title: "[ENHANCEMENT]" +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. Include links to external sites and information that may be useful as reference for the feature or enhancement. From ae06b9607d92d5b524595182cf7bdbf68478d45a Mon Sep 17 00:00:00 2001 From: Todd Viegut Date: Fri, 8 Nov 2024 09:20:49 -0600 Subject: [PATCH 4/4] Update issue templates --- .github/ISSUE_TEMPLATE/cimtool-bug-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/cimtool-bug-report.md b/.github/ISSUE_TEMPLATE/cimtool-bug-report.md index 239a368..9fe6a4a 100644 --- a/.github/ISSUE_TEMPLATE/cimtool-bug-report.md +++ b/.github/ISSUE_TEMPLATE/cimtool-bug-report.md @@ -10,10 +10,10 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. This should include a high level description of what you were trying to do that produced the issue. (e.g. "While creating a new profile I selected the -** CIMTool release** +**CIMTool release** The exact release of CIMTool you were using (e.g. CIMTool 2.0.1) -** CIM Schema version ** +**CIM Schema Version** If relevant to the bug you are reporting, please include the exact name of the schema(s) you are using for your profiling. For example: - iec61970cim17v38_iec61968cim13v13b_iec62325cim03v17a_CIM100.2.eap - iec61970cim17v40-cimtool.xmi