From 53ac2ec06d385e34ba0537dcf72675c664f7efd9 Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Tue, 19 Mar 2024 23:52:03 +0100 Subject: [PATCH 01/10] add more detailes to feature template --- .github/ISSUE_TEMPLATE/1_feature_template.md | 22 ++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index 1d15d1b9..23adc002 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -10,15 +10,29 @@ What is the purpose, what´s the expected result. Please describe. --> -## Impact +## Impact/Dependencies -## Additional information - -- [ ] I'm willing to contribute to this feature +## Acceptance Criteria + +- [ ] Criteria 1 +- [ ] Criteria 2 +- [ ] Criteria 3 +## Linked Subtasks/Product specific tasks + +- [ ] Issue 1 to product repository +- [ ] Issue 2 to product repository +- [ ] Issue 3 to product repository +## Additional information +- [ ] I'm willing to contribute to this feature +- [ ] I provide necessary developer resources From f3e9e9a84afa438711bc90877b8cbc67c5a42726 Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Tue, 1 Oct 2024 16:34:18 +0200 Subject: [PATCH 02/10] Update .github/ISSUE_TEMPLATE/1_feature_template.md Co-authored-by: Malte Hellmeier --- .github/ISSUE_TEMPLATE/1_feature_template.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index 23adc002..59d3f5d7 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -16,6 +16,18 @@ If possible, please provide insight in what and how many components and teams mi If there are dependencies to other features please name it. --> +### Architecture Management Committee Check + +The following items are ensured (answer: yes) after this issue is implemented: + +- [ ] **Architecture:** This issue is compliant with the [overarching architecture](https://eclipse-tractusx.github.io/docs/tutorials/e2e/inform/architecture) and its existing standards and protocols +- [ ] **Data Sovereignty:** All data sharing activities across company boundaries follow 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)) +- [ ] **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)) +- [ ] **Data Format:** The data model is based on a [published Semantic Model](https://github.com/eclipse-tractusx/sldt-semantic-models) + +**Justification:** _(Only needs to be filled out if at lease one checkbox item could not be answered with "yes")_ ## Acceptance Criteria -## Impact/Dependencies +## Feature Team + +### Contributor + +- Contributor 1 +- Contributor 2 + +### Committer + +- Committer 1 +- Committer 2 + + +## Explain the topic in 2 sentences + + +## What's the benefit? + + +## What are the Risks/Dependencies ? + + +## Detailed explanation + + +### Current implementation + +### Proposed improvements + +## User Stories + +- Issue 1, linked to specific repository +- Issue 2, linked to another specific repository + +## Acceptance Criteria +- [ ] Criteria 1 +- [ ] Criteria 2 +- [ ] Criteria 3 + +## Test cases + + +### TestCase 1 + + +#### Steps + +1. Do something +2. Click something +3. Add something + +#### Expected Result + +1. Expectation +2. Expectation +3. Expectation ### Architecture Management Committee Check -- [ ] Criteria 1 -- [ ] Criteria 2 -- [ ] Criteria 3 - -## Linked Subtasks/Product specific tasks - -- [ ] Issue 1 to product repository -- [ ] Issue 2 to product repository -- [ ] Issue 3 to product repository - -## Additional information +## Additional information + - [ ] I'm willing to contribute to this feature - [ ] I provide necessary developer resources + +PLease see here an [example feature](https://github.com/eclipse-tractusx/sig-release/issues/882) From bddf7fe007cb6200e455db667588c4c8e8a4d47d Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Wed, 2 Oct 2024 18:38:10 +0200 Subject: [PATCH 04/10] typo --- .github/ISSUE_TEMPLATE/1_feature_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index a57dfc60..f120d4a8 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -88,4 +88,4 @@ The following items are ensured (answer: yes) after this issue is implemented: - [ ] I'm willing to contribute to this feature - [ ] I provide necessary developer resources -PLease see here an [example feature](https://github.com/eclipse-tractusx/sig-release/issues/882) +Please see here an [example feature](https://github.com/eclipse-tractusx/sig-release/issues/882) From a9616fad35468103bdc16c4e84c7d7d5abcd9fba Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Wed, 2 Oct 2024 19:08:17 +0200 Subject: [PATCH 05/10] add architectural relevance --- .github/ISSUE_TEMPLATE/1_feature_template.md | 32 ++++++++++++++------ 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index f120d4a8..a0f43c45 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -8,6 +8,8 @@ about: propose a new functionality 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) --> ## Feature Team @@ -70,22 +72,34 @@ Add all Acceptence Criteria. These criteria are important for the definition of 2. Expectation 3. Expectation -### Architecture Management Committee Check +### Architectural Relevance The following items are ensured (answer: yes) after this issue is implemented: -- [ ] **Architecture:** This issue is compliant with the [overarching architecture](https://eclipse-tractusx.github.io/docs/tutorials/e2e/inform/architecture) and its existing standards and protocols -- [ ] **Data Sovereignty:** All data sharing activities across company boundaries follow 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)) -- [ ] **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)) -- [ ] **Data Format:** The data model is based on a [published Semantic Model](https://github.com/eclipse-tractusx/sldt-semantic-models) - -**Justification:** _(Only needs to be filled out if at lease one checkbox item could not be answered with "yes")_ +- [ ] This feature aligns with our current architectural guidelines + - **Data Sovereignty:** All data sharing activities across company boundaries follow 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 Eclipse Data Space Connector (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-EclipseDataSpaceConnector) + - [ ] [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 Eclipse Data Space Connector (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-EclipseDataSpaceConnector) + - **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? 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 +- [ ] The feature doesnt introduce any new dependencies or requires changes to current architectural components +- [ ] Architectural stakeholders (e.g., architects, technical leads) has been consulted + +**Justification:** _(Only needs to be filled out if at lease one checkbox item could not be answered with "yes" -> please contact also the Architectjure Management Committee)_ ## Additional information - [ ] I'm willing to contribute to this feature - [ ] I provide necessary developer resources - -Please see here an [example feature](https://github.com/eclipse-tractusx/sig-release/issues/882) From 48f3b2528a838d89aa82c3298b91b2a9e2817bc7 Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Sat, 5 Oct 2024 18:28:21 +0200 Subject: [PATCH 06/10] Apply suggestions from code review Co-authored-by: Lars Geyer-Blaumeiser --- .github/ISSUE_TEMPLATE/1_feature_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index a0f43c45..452b2e67 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -92,14 +92,14 @@ The following items are ensured (answer: yes) after this issue is implemented: - [ ] [CX-0018 Eclipse Data Space Connector (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-EclipseDataSpaceConnector) - **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? Please have a look here on the [overarching architecture](https://eclipse-tractusx.github.io/docs/tutorials/e2e/inform/architecture) +- [ ] 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 - [ ] The feature doesnt introduce any new dependencies or requires changes to current architectural components - [ ] Architectural stakeholders (e.g., architects, technical leads) has been consulted -**Justification:** _(Only needs to be filled out if at lease one checkbox item could not be answered with "yes" -> please contact also the Architectjure Management Committee)_ +**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 -- [ ] I'm willing to contribute to this feature +- [ ] 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 From 84dd54c120bae40fb5ed9aad251a8a92f103a6fb Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Sat, 5 Oct 2024 18:29:56 +0200 Subject: [PATCH 07/10] Adapt Architectural Relevance after review --- .github/ISSUE_TEMPLATE/1_feature_template.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index 452b2e67..4859647f 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -94,8 +94,6 @@ The following items are ensured (answer: yes) after this issue is implemented: - [ ] 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 -- [ ] The feature doesnt introduce any new dependencies or requires changes to current architectural components -- [ ] Architectural stakeholders (e.g., architects, technical leads) has been consulted **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)_ From 330ada90b588df8c2da55ba6311bc4ee7788433f Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Sat, 5 Oct 2024 18:30:33 +0200 Subject: [PATCH 08/10] fix markdown linter issues --- .github/ISSUE_TEMPLATE/1_feature_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index 4859647f..b9d7284a 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -99,5 +99,5 @@ The following items are ensured (answer: yes) after this issue is implemented: ## Additional information -- [ ] 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 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 From 6fb4f8c3acb70b2cb642f96b6a243a7566697e9d Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Mon, 7 Oct 2024 08:41:24 +0200 Subject: [PATCH 09/10] adapt template after review --- .github/ISSUE_TEMPLATE/1_feature_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index b9d7284a..acb7b1f5 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -79,17 +79,17 @@ The Architecture Management Committee monitors and controls the overarching arch 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 [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)) + - **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 Eclipse Data Space Connector (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-EclipseDataSpaceConnector) + - [ ] [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 Eclipse Data Space Connector (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-EclipseDataSpaceConnector) + - [ ] [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) From d056cb16a30de2f814d16a0c5664f1e559d1156a Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Mon, 7 Oct 2024 10:13:02 +0200 Subject: [PATCH 10/10] Update .github/ISSUE_TEMPLATE/1_feature_template.md Co-authored-by: Mathias Moser <71728767+matbmoser@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/1_feature_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md index acb7b1f5..ae7b4869 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_template.md +++ b/.github/ISSUE_TEMPLATE/1_feature_template.md @@ -32,7 +32,7 @@ Please see here an [example feature](https://github.com/eclipse-tractusx/sig-rel ## What are the Risks/Dependencies ? - + ## Detailed explanation