From cd09ac68f909fa395564a5c447877ed113e32c05 Mon Sep 17 00:00:00 2001 From: Simon Aronsson Date: Tue, 3 Dec 2024 14:14:19 +0100 Subject: [PATCH 1/4] decision(issues): add draft decision about how to create issues and prs --- ...-03--creating-issues-in-github-and-jira.md | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 decision-records/2024-12-03--creating-issues-in-github-and-jira.md diff --git a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md new file mode 100644 index 0000000..601219e --- /dev/null +++ b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md @@ -0,0 +1,48 @@ +# Creating issues in GitHub and Jira + +**Date:** 2024-12-03
+**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 then ". +- 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. + +### 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, + + > [()]: description + + for example: + + > bug(charm-tracing): call the `setup` function whenever something is being set up + +## Considered alternatives + +- https://gitmoji.dev/ for pull requests. Becomes annoying to parse, and hard to remember. From 5f8fbc810a66ea669f5648a7cf6593de28ae83e1 Mon Sep 17 00:00:00 2001 From: Simon Aronsson Date: Tue, 3 Dec 2024 17:58:53 +0100 Subject: [PATCH 2/4] Update decision-records/2024-12-03--creating-issues-in-github-and-jira.md Co-authored-by: PietroPasotti Signed-off-by: Simon Aronsson --- .../2024-12-03--creating-issues-in-github-and-jira.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md index 601219e..fa5adbf 100644 --- a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md +++ b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md @@ -21,7 +21,7 @@ rephrase it as part of the triage. - 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 then ". + this format: "When then ". - 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". From 68631f6691c02c78f15850587b46ee1cfb885e74 Mon Sep 17 00:00:00 2001 From: Simon Aronsson Date: Tue, 3 Dec 2024 18:04:30 +0100 Subject: [PATCH 3/4] Update decision-records/2024-12-03--creating-issues-in-github-and-jira.md Signed-off-by: Simon Aronsson --- .../2024-12-03--creating-issues-in-github-and-jira.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md index fa5adbf..a70de25 100644 --- a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md +++ b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md @@ -41,7 +41,12 @@ rephrase it as part of the triage. for example: - > bug(charm-tracing): call the `setup` function whenever something is being set up + > fix(charm-tracing): call the `setup` function whenever something is being set up + + The valid prefixes are: + - feature + - chore + - fix ## Considered alternatives From 2ccd3546005c337131056b92fd288efac0d0ecd5 Mon Sep 17 00:00:00 2001 From: Simon Aronsson Date: Tue, 3 Dec 2024 18:04:58 +0100 Subject: [PATCH 4/4] Update decision-records/2024-12-03--creating-issues-in-github-and-jira.md Signed-off-by: Simon Aronsson --- .../2024-12-03--creating-issues-in-github-and-jira.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md index a70de25..ac07d0d 100644 --- a/decision-records/2024-12-03--creating-issues-in-github-and-jira.md +++ b/decision-records/2024-12-03--creating-issues-in-github-and-jira.md @@ -43,7 +43,7 @@ rephrase it as part of the triage. > fix(charm-tracing): call the `setup` function whenever something is being set up - The valid prefixes are: + The valid types are: - feature - chore - fix