style: Format use cases and design process items #1232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz
commented
Sep 20, 2023
Comment on lines
53
to
+70
| ## Project Board Cards and Issues | ||
|
|
||
| All project design/architectural design decisions captured on the Design Decisions project board will be created as either a: | ||
| All project design/architectural design decisions captured on the Design Decisions project board will be created as either: | ||
|
|
||
| Issue: for any design decision that will require code and a PR will be submitted against the issue. | ||
| Card: for any design decision that is not itself going to result in code or may need to be broken down into multiple issues (which can be referenced on the card). | ||
| - Issue: for any design decision that will require code and a PR will be submitted against the issue. | ||
| - Card: for any design decision that is not itself going to result in code or may need to be broken down into multiple issues (which can be referenced on the card). | ||
|
|
||
| The template for project board cards documenting each decision is: | ||
|
|
||
| When/Where: date of the decision and place where the decision was made (such as TSC meeting, working group meeting, etc.). This section is required. | ||
| Decision Summary: quick write-up on the decision. This section is required. | ||
| Notes/Considerations: any alternatives discussed, any impacts to other decisions or considerations to be considered in the future (which would negate the decision). This section is optional. | ||
| > **When/Where:** date of the decision and place where the decision was made (such as TSC meeting, working group meeting, etc.). This section is required. | ||
| > | ||
| > **Decision Summary:** quick write-up on the decision. This section is required. | ||
| > | ||
| > **Notes/Considerations:** any alternatives discussed, any impacts to other decisions or considerations to be considered in the future (which would negate the decision). This section is optional. | ||
| > | ||
| > **Relevant links:** link to the meeting recording (if available). Link to ADR if relevant. Link to PRs or Issues if relevant. Required if available. | ||
|
|
||
| Relevant links: link to the meeting recording (if available). Link to ADR if relevant. Link to PRs or Issues if relevant. Required if available. | ||
|
|
||
| Note there is a Template column on the project board with a single card that specifies this same structure. | ||
| Note: there is a Template column on the project board with a single card that specifies this same structure. |
There was a problem hiding this comment.
Are any of these and this whole section still relevant? I could not find such a Template column on project board? Which project board (we have several)?
There was a problem hiding this comment.
This is the project board being referenced here: https://github.com/orgs/edgexfoundry/projects/45
Should add a link to it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md
PR Checklist
Please check if your PR fulfills the following requirements: