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

Create KIT Issue Template #983

Merged
merged 10 commits into from
Jan 14, 2025

Conversation

ther3sa
Copy link
Contributor

@ther3sa ther3sa commented Oct 28, 2024

Description

Created KIT Issue Template with topics

  • Description
  • Impact
  • KIT Team
  • Architectural Relevance

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@ther3sa ther3sa self-assigned this Oct 28, 2024
@ther3sa ther3sa marked this pull request as ready for review October 28, 2024 15:42
@stephanbcbauer stephanbcbauer requested a review from a team October 29, 2024 14:55
@ther3sa ther3sa requested a review from arnoweiss October 29, 2024 15:47
Copy link
Member

@mhellmeier mhellmeier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is important to mention and link to our TRGs. For example, we have the TRG 9.01 especially for KITs:
https://eclipse-tractusx.github.io/docs/release/trg-0/trg-9-01

The feature template should include a checkbox to validate if it confirms the relevant TRGs.

Maybe this could make more sense to include it in a pull request template for KITs.

arnoweiss
arnoweiss previously approved these changes Oct 29, 2024
Copy link

@eckardg eckardg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine for me, thanks!

matbmoser
matbmoser previously approved these changes Oct 30, 2024
Copy link
Contributor

@matbmoser matbmoser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine for me

@tom-rm-meyer-ISST
Copy link
Contributor

It is important to mention and link to our TRGs. For example, we have the TRG 9.01 especially for KITs: https://eclipse-tractusx.github.io/docs/release/trg-0/trg-9-01

The feature template should include a checkbox to validate if it confirms the relevant TRGs.

Maybe this could make more sense to include it in a pull request template for KITs.

The template is for KIT Feature proposals during planning not for the QGate Tickets. Thus, I would not mention the TRGs already at that state.

Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small improvements and one big question: Do we really want the architectural relevance checks in the feature template? Similar to my comment on the TRGs, the architectural relevance may be checked only during QGate.

As no KITs are creaed if no standard exists, the architectural relevance should have already been gatekeept on standardization level.

- [ ] [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 Dataspace Connectivity](https://catenax-ev.github.io/docs/next/standards/CX-0018-DataspaceConnectivity)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Please remove empty line

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"As no KITs are creaed if no standard exists" -> I would not say that this is always the case. And often it is only visible in the KIT how the standard is going to be applied.
To my mind, it helps to bring the guidelines as soon as possible to awareness.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@jSchuetz88 jSchuetz88 Dec 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"As no KITs are creaed if no standard exists" -> I would not say that this is always the case. And often it is only visible in the KIT how the standard is going to be applied. To my mind, it helps to bring the guidelines as soon as possible to awareness.

Technically @eckardg is right - see maturity level "Sandbox": https://eclipse-tractusx.github.io/documentation/kit-maturity-levels/), but I still agree with @tom-rm-meyer-ISST here. As a KIT at the Sandbox-stage provides only a "vision" and business objective, the guardrails can not be applied in a meaningful way at this stage. And for the next maturity stage "Incubating", standards are already mandatory.

Personally I would prefer just one additional check with "This feature aligns with our current set of standards."

.github/ISSUE_TEMPLATE/5_KIT_template.md Outdated Show resolved Hide resolved
@ther3sa ther3sa dismissed stale reviews from matbmoser and arnoweiss via 91028c4 December 6, 2024 15:31
.github/ISSUE_TEMPLATE/5_KIT_template.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/5_KIT_template.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/5_KIT_template.md Outdated Show resolved Hide resolved
@ther3sa ther3sa requested a review from lgblaumeiser December 12, 2024 09:14
stephanbcbauer
stephanbcbauer previously approved these changes Dec 13, 2024
Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stephanbcbauer
Copy link
Member

@tom-rm-meyer-ISST you requested changes, is this done? Thx :)

lgblaumeiser
lgblaumeiser previously approved these changes Dec 16, 2024
Copy link
Contributor

@lgblaumeiser lgblaumeiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for incorporation. This is lean and not mentioning the TRGs makes sense.

Just a comment: line 26 and 27 is a duplicate blank line that has not used between headings elsewhere. But changing this would make "reassessment" necessary.

Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stephanbcbauer stephanbcbauer merged commit 52adb7f into eclipse-tractusx:main Jan 14, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants