Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backmerge the Issues templates to the 2.3.0 branch #190

Merged
merged 4 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/cimtool-bug-report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/cimtool-feature-or-enhancement-request.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/core-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Loading