Skip to content
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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 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
_modus ponens_, i.e "When <condition> then <outcome>".
simskij marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

- 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:

> bug(charm-tracing): call the `setup` function whenever something is being set up
simskij marked this conversation as resolved.
Show resolved Hide resolved

## Considered alternatives

- https://gitmoji.dev/ for pull requests. Becomes annoying to parse, and hard to remember.
Loading