-
Notifications
You must be signed in to change notification settings - Fork 8
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't mind merging the PR like it is. Maybe with a reconsideration of how links between issues are done.
But I also have a slightly different idea. I heared from the OpenTofu project, that the split the feature request part in two. See their contribution guide First, a very simple template can be use, so it is possible for everyone to create features. These proposals are discussed on that simple level, and when it is agreed to work on it, a RFC is created, stating details about UX, DX, Architecture and so on.
I think that could keep the barrier to entry lower. What do you think @stephanbcbauer
|
||
## Linked Subtasks/Product specific tasks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the link should be made from the product specific repos to this one here. Otherwise you always have to edit the description, as soon as a new "subtask" is created. Linking it this way, will also show the status of the issue (open or closed. merged for PRs). With a simple check list, you always need to manually tick them
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could add this information within the info part like
<!--
- [ ] Criteria 1
- [ ] Criteria 2
- [ ] Criteria 3
-->
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @stephanbcbauer overall cool idea but i also share the opinion from sebastian to make it more transparent within the issue template that some further steps should be planned in the product repos and mention the overall issue itself.
@@ -10,15 +10,29 @@ What is the purpose, what´s the expected result. | |||
Please describe. | |||
--> | |||
|
|||
## Impact | |||
## Impact/Dependencies |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Impact/Dependencies | |
## Impact/ Dependencies |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would not accept this, since slashes are always used without spacings.
There are usually no spaces either before or after a slash. According to New Hart's Rules: The Oxford Style Guide, a slash is usually written without spacing on either side when it connects single words, letters or symbols.
|
||
## Linked Subtasks/Product specific tasks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could add this information within the info part like
<!--
- [ ] Criteria 1
- [ ] Criteria 2
- [ ] Criteria 3
-->
|
||
- [ ] I'm willing to contribute to this feature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: How to deal with this checkbox, in case that more than one person is willing to contribute - which is hopefully the standard case in the future :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess depends on the working model, but if the person who wrote the issue is willing to contribute and want to add more people to this issue ... then the writer can easily change the description within the template "we are willing to contribute"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a baseline set of checks from the Architecture Management Committee.
@@ -10,15 +10,29 @@ What is the purpose, what´s the expected result. | |||
Please describe. | |||
--> | |||
|
|||
## Impact | |||
## Impact/Dependencies | |||
<!-- | |||
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. | |||
--> | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### Architecture Management Committee Check | |
<!-- | |
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: | |
- [ ] **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")_ |
Description
Since the feature requester needs more guidance about the feature description/specification, this PR adds more attributes/information to the feature template.
This information was also needed to measure the definition of ready ⇾ ready refined and in the end definition of done.
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: