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

feat(issue template): add more details to feature template #571

Merged
merged 11 commits into from
Oct 7, 2024
91 changes: 85 additions & 6 deletions .github/ISSUE_TEMPLATE/1_feature_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,101 @@ name: Propose a Feature
about: propose a new functionality
---

## Description
# Description
<!--
A clear and concise description of what the desired feature will look like.
What is the purpose, what´s the expected result.
Please describe.

Please see here an [example feature](https://github.com/eclipse-tractusx/sig-release/issues/882)
-->

stephanbcbauer marked this conversation as resolved.
Show resolved Hide resolved
## Impact
## Feature Team

### Contributor
<!-- names are already needed for open planning -->
- Contributor 1
- Contributor 2

### Committer
<!-- names are already needed for open planning -->
- Committer 1
- Committer 2
<!-- can be delivered after Planning Phase 1 -->

## Explain the topic in 2 sentences
<!-- provide a short overview -->

## What's the benefit?
<!-- do we increase security/efficiency/ reduce complexity? -->

## What are the Risks/Dependencies ?
<!-- breaking change ? do you have interface partner you need to align with ? does it require review from the architecture team? -->

## Detailed explanation
<!-- explain the idea in detail , what is the current situation , what needs to be changed -->

### Current implementation

### Proposed improvements

## User Stories
<!-- define the sub-issues that lead to the full developement of this feature -->
- Issue 1, linked to specific repository
- Issue 2, linked to another specific repository

## Acceptance Criteria
<!--
If possible, please provide insight in what and how many components and teams might be affected or give a hint, if the feature implementation might result in breaking changes.
If there are dependencies to other features please name it.
Add all Acceptence Criteria. These criteria are important for the definition of done
-->
- [ ] Criteria 1
- [ ] Criteria 2
- [ ] Criteria 3

## Test cases
<!-- add testcases - proposed structure (Description/Steps/Expected Result) -->

### TestCase 1
<!-- description -->

#### Steps

## Additional information
1. Do something
2. Click something
3. Add something

- [ ] I'm willing to contribute to this feature
#### Expected Result

1. Expectation
2. Expectation
3. Expectation

### Architectural Relevance
<!--
The Architecture Management Committee monitors and controls the overarching architecture. It is essential that all applications and documentations follows a baseline set of standards and guidelines. These small checks ensure that the proposed change does not compromise our general principles.
-->
The following items are ensured (answer: yes) after this issue is implemented:

- [ ] This feature aligns with our current architectural guidelines
- **Data Sovereignty:** All data sharing activities across company boundaries follow the [Catena-X Regulatory Framework](https://catenax-ev.github.io/docs/next/regulatory-framework/governance-framework), in particular the [Data Exchange Governance](https://catenax-ev.github.io/docs/next/regulatory-framework/20000ft/data-exchange-governance), and the [Dataspace Protocol](https://docs.internationaldataspaces.org/dataspace-protocol/overview/readme) via a compliant Connector (like the [tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) or similar, see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit))
- [ ] [CX-0010 Business Partner Number](https://catenax-ev.github.io/docs/next/standards/CX-0010-BusinessPartnerNumber)
- [ ] [CX-0013 Identity of Member Companies](https://catenax-ev.github.io/docs/next/standards/CX-0013-IdentityOfMemberCompanies)
- [ ] [CX-0018 Data Space Connectivity (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-DataspaceConnectivity)
- [ ] [CX-0049 DID Document Schema](https://catenax-ev.github.io/docs/next/standards/CX-0049-DIDDocumentSchema)
- [ ] [CX-0050 Framework Agreement Credential](https://catenax-ev.github.io/docs/next/standards/CX-0050-FrameworkAgreementCredential)
- [ ] [CX-0149 Verified Company Identity](https://catenax-ev.github.io/docs/next/standards/CX-0149-Dataspaceidentityandidentification)
- **Interoperability:** Digital Twins are used (compliant to the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/digital-twin-kit) and the [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit))
- [ ] [CX-0001 EDC Discovery API](https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI)
- [ ] [CX-0002 Digital Twins in Catena-X](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX)
- [ ] [CX-0018 Data Space Connectivity (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-DataspaceConnectivity)
- **Data Format:**
- [ ] The data model is based on a [published Semantic Model](https://github.com/eclipse-tractusx/sldt-semantic-models)
- [ ] The impact on the overall system architecture has been assessed? The feature does not require changes to the architecture or any existing standard? Please have a look here on the [overarching architecture](https://eclipse-tractusx.github.io/docs/tutorials/e2e/inform/architecture)
- [ ] Potential risks or conflicts with existing architecture has been assessed

**Justification:** _(Fill this out, if at least one of the checkboxes above cannot be ticked. Contact the Architecture Management Committee to get an approval for the justification)_

## Additional information
<!-- this is only needed, if contributors and committers are not known during feature creation -->
- [ ] I leave this unticked as it is natural for me, that I only propose features for which I commit the proper invest to get them implemented. If I have to tick it, I understand that contributing a feature without the capacity to implement it is very bad style, but I humbly ask for support because I still think this is a great idea.
- [ ] I provide necessary developer resources
Loading