-
Notifications
You must be signed in to change notification settings - Fork 12
rework release templates #232
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
base: main
Are you sure you want to change the base?
Conversation
|
The created documentation from the pull request is available at: docu-html |
|
|
||
| - @{{CONTRIBUTOR_1}} | ||
| - @{{CONTRIBUTOR_2}} | ||
|
|
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.
This template misses know limitations which means relevant open issues. This is relevant for component, feature, and platform.
For platform level it needs to collect features.
For feature it needs to collect the component issues.
Explicit CVE report makes also sense as known limitations.
Same would make be helpful for safety.
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.
Template updated with missing information, but we have only platform and module releases, not more. CVE Section added
| # ******************************************************************************* | ||
|
|
||
| # Some portions generated by Co-Pilot | ||
|
|
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.
There need to be the purpose of the release described. E.g. what is the safety level.
What is the release maturity: Ranging from only for testing in virtual environment up to production ready.
I assume this cannot be auto generated. So there might be the need by someone like a quality manager or project lead which gives an overall statement on the achieved quality.
We should consider a link to the user documentation of the released software as e.g. feature documentation within the feature repo.
Another point could be the external dependencies to other components.
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.
Please let's discuss about maturity in our meetings, not changed so far.
.github/RELEASE_TEMPLATE.md
Outdated
| ### Refactoring | ||
| - {{REFACTOR_1}} ([#{{PR_NUMBER}}]({{PR_LINK}})) | ||
|
|
||
| EST_UPDATE_1}} ([#{{PR_NUMBER}}]({{PR_LINKentation |
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.
| EST_UPDATE_1}} ([#{{PR_NUMBER}}]({{PR_LINKentation | |
| EST_UPDATE_1}} ([#{{PR_NUMBER}}]({{PR_LINK}} |
Wrong style in this and other line.
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.
changed
| # ******************************************************************************* | ||
|
|
||
| # Some portions generated by Co-Pilot | ||
|
|
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.
Is it a good idea to have a disclaimer on what we promise and what not?
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.
added
2b1f847 to
c639541
Compare
c639541 to
3004164
Compare
No description provided.