-
Notifications
You must be signed in to change notification settings - Fork 11
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
decision(issues): add draft decision about how to create issues and prs #242
Open
simskij
wants to merge
4
commits into
main
Choose a base branch
from
decision/issues
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
cd09ac6
decision(issues): add draft decision about how to create issues and prs
simskij 5f8fbc8
Update decision-records/2024-12-03--creating-issues-in-github-and-jir…
simskij 68631f6
Update decision-records/2024-12-03--creating-issues-in-github-and-jir…
simskij 2ccd354
Update decision-records/2024-12-03--creating-issues-in-github-and-jir…
simskij File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
53
decision-records/2024-12-03--creating-issues-in-github-and-jira.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Creating issues in GitHub and Jira | ||
|
||
**Date:** 2024-12-03<br/> | ||
**Authors:** @simskij | ||
|
||
## Context and Problem Statement | ||
|
||
As the team have grown, we've ended up diverging in our practices on how to create issues in our | ||
repositories. To be able to work efficiently and consistently with our issues, we need to follow some | ||
common practices, so that the workflow remains the same across issues. | ||
|
||
## Decision | ||
|
||
These rules only apply to tickets opened by us. If someone else opens the ticket, we should | ||
rephrase it as part of the triage. | ||
|
||
### Issue Titles | ||
|
||
- Issues are always to be created in GitHub, unless confidentiality requirements dictate something | ||
else. However, this is almost never the case. If you are unsure - ask @simskij or @sed-i. | ||
- 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>". | ||
- Issue titles should _not_ contain any prefixes or namespaces, instead this should be part of | ||
the problem statement. I.e. "Write a document explaining the topic" rather than "[doc/explanation] | ||
Topic". | ||
|
||
### Issue Estimation | ||
|
||
- Issues should be estimated using the "Original time estimate"-field in Jira. | ||
- Issues expected to take less than a full day of work (8 hours) should be estimated in full hours. | ||
- Issues expected to take longer than a full day of work (8 hours) should be estimated in whole days. | ||
simskij marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Pull Requests | ||
|
||
- Pull request titles should be following the conventional commit format, which you can read | ||
[here](https://www.conventionalcommits.org/en/v1.0.0/). In essence, | ||
|
||
> <type>[(<scope>)]: description | ||
|
||
for example: | ||
|
||
> fix(charm-tracing): call the `setup` function whenever something is being set up | ||
|
||
The valid prefixes are: | ||
simskij marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- feature | ||
- chore | ||
- fix | ||
|
||
## Considered alternatives | ||
|
||
- https://gitmoji.dev/ for pull requests. Becomes annoying to parse, and hard to remember. |
Oops, something went wrong.
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.
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.
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.