decision(issues): add draft decision about how to create issues and prs #242
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
decision-records/2024-12-03--creating-issues-in-github-and-jira.md
Outdated
Show resolved
Hide resolved
| - Issues of the story/enhancement type should have a title that describes the work to be done in | ||
| the _imperative modus_, i.e "Add a bip to the bop", rather than "We should add a bip to the bop" | ||
| - Issues of the bug type should have a title that describes the bug occuring, written in | ||
| _modus ponens_, i.e "When <condition> then <outcome>". |
There was a problem hiding this comment.
Suggested change
| _modus ponens_, i.e "When <condition> then <outcome>". | |
| _modus ponens_, i.e "When <condition> then <outcome>". When necessary, add a description of why the outcome is bad and what would you expect 'good' to look like. |
decision-records/2024-12-03--creating-issues-in-github-and-jira.md
Outdated
Show resolved
Hide resolved
…a.md Co-authored-by: PietroPasotti <[email protected]> Signed-off-by: Simon Aronsson <[email protected]>
…a.md Signed-off-by: Simon Aronsson <[email protected]>
simskij
commented
Dec 3, 2024
decision-records/2024-12-03--creating-issues-in-github-and-jira.md
Outdated
Show resolved
Hide resolved
…a.md Signed-off-by: Simon Aronsson <[email protected]>
mmkay
reviewed
Dec 5, 2024
| - Issues of the story/enhancement type should have a title that describes the work to be done in | ||
| the _imperative modus_, i.e "Add a bip to the bop", rather than "We should add a bip to the bop" | ||
| - Issues of the bug type should have a title that describes the bug occuring, written in | ||
| this format: "When <condition> then <outcome>". |
There was a problem hiding this comment.
It's surpisingly hard to describe complex scenarios that way. Just started writing a bug named
"When charm is related to grafana-agent without a connected tracing backend then cos-agent exposes an inaccessible tracing URL" which doesn't sound easy to say in a status update. I think it makes sense as a guideline, but not necessarily a rule.
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.
A first draft on our rules for creatinmg issues and prs.
Feedback much appreciated!