From 4af7011819d6b4e3fbd702718d895ae2564d246b Mon Sep 17 00:00:00 2001 From: David Benedeki Date: Mon, 15 Sep 2025 19:03:21 +0200 Subject: [PATCH 1/2] #77: Add Business Value chapter to issue templates * changed existing templates * added new templates for _operative assignment_, _epic_ and _spike_ * removed _question_ template --- .github/ISSUE_TEMPLATE/bug_report.md | 13 ++++--- .github/ISSUE_TEMPLATE/epic.md | 17 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 7 ++-- .../ISSUE_TEMPLATE/operative_assignment.md | 10 ++++++ .github/ISSUE_TEMPLATE/question.md | 13 ------- .github/ISSUE_TEMPLATE/release.md | 10 ++++++ .github/ISSUE_TEMPLATE/release_notes.md | 10 ------ .github/ISSUE_TEMPLATE/spike.md | 36 +++++++++++++++++++ 8 files changed, 84 insertions(+), 32 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/epic.md create mode 100644 .github/ISSUE_TEMPLATE/operative_assignment.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/release.md delete mode 100644 .github/ISSUE_TEMPLATE/release_notes.md create mode 100644 .github/ISSUE_TEMPLATE/spike.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2c0a791..3e54ecf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,8 +1,8 @@ --- name: Bug report about: Create a report to help us improve -labels: 'bug, priority: undecided' - +labels: 'bug' +type: 'Bug' --- ## Describe the bug @@ -18,13 +18,12 @@ Steps to reproduce the behavior OR commands run: ## Expected behavior A clear and concise description of what you expected to happen. +## Business Value +The business value of the requested bugfix. +You can also refer to the reporting team to confirm that the issue has been fixed. + ## Screenshots If applicable, add screenshots to help explain your problem. -## Desktop (please complete the following information): - - OS: [e.g. iOS] - - Versions of libraries (Spark, Scala, ...) - - Version [e.g. 22] - ## Additional context Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md new file mode 100644 index 0000000..7033fc7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -0,0 +1,17 @@ +--- +name: Epic +about: A larger task consisting of more deliverables +labels: 'epic' +type: 'Epic' +--- + +## Background +A clear and concise intro into the situation. + +## Goal +The goal that epic wants to achieve. + +## Business Value +The business value of achieving the goal. + +[Add actionable subtasks or even epics] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 84b87ff..d3fd3fb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,8 +1,8 @@ --- name: Feature request about: Suggest an idea for this project -labels: 'feature, under discussion, priority: undecided' - +labels: 'enhancement' +type: 'Feature' --- ## Background @@ -11,6 +11,9 @@ A clear and concise description of where the limitation lies. ## Feature A description of the requested feature. +## Business Value +The business value of the requested feature. + ## Example [Optional] A simple example if applicable. diff --git a/.github/ISSUE_TEMPLATE/operative_assignment.md b/.github/ISSUE_TEMPLATE/operative_assignment.md new file mode 100644 index 0000000..0c050dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/operative_assignment.md @@ -0,0 +1,10 @@ +--- +name: Operative assignment +about: Issue template for an assignment about setting up the project, it's management or documentation. Usually not touching the codebase. +labels: 'infrastructure,no RN' +type: 'Task' +--- + +## The assignment + +Short description of the assignment. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 69f2c37..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Question -about: Ask a question -labels: 'question, priority: undecided' - ---- - -## Background [Optional] -A clear explanation of the reason for raising the question. -This gives us a better understanding of your use cases and how we might accommodate them. - -## Question -A clear and concise inquiry diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md new file mode 100644 index 0000000..125b15f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release.md @@ -0,0 +1,10 @@ +--- +title: Create a release of vX.Y.0 +name: Release +about: Create a release and release notes +labels: 'documentation,infrastructure,no RN' +type: 'Task' +--- + +## Background +Version vX.Y.0 can be released, including its release notes diff --git a/.github/ISSUE_TEMPLATE/release_notes.md b/.github/ISSUE_TEMPLATE/release_notes.md deleted file mode 100644 index 9ecf8e0..0000000 --- a/.github/ISSUE_TEMPLATE/release_notes.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Add release notes for vX.Y.0 -name: Release Notes -about: Create release notes -labels: 'docs, priority: medium' - ---- - -## Background -With the release of vX.Y.0, we should add its release notes to the docs. diff --git a/.github/ISSUE_TEMPLATE/spike.md b/.github/ISSUE_TEMPLATE/spike.md new file mode 100644 index 0000000..002d953 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spike.md @@ -0,0 +1,36 @@ +--- +name: Spike +about: Issue template for spikes, research and investigation tasks +labels: 'spike' +type: 'Task' +--- + +## Background +A clear and concise description of the problem or a topic we need to understand. + +Feel free to add information about why it's needed and what assumptions you have at the moment. + +## Questions To Answer + +1. +2. +3. + +## Business Value +The business value of the requested investigation. + +## Desired Outcome +The list of desired outcomes of this spike ticket. + +### Tasks +- [ ] Questions have been answered or we have a clearer idea of how to get to our goal +- [ ] Discussion with the team +- [ ] Documentation +- [ ] Create recommendations and new implementation tickets +- [ ] item here.. + +## Additional Info/Resources [Optional] + +1. +2. +3. From 7f31f1e25dcaab5a8d695380aeed4adf368ce5ab Mon Sep 17 00:00:00 2001 From: David Benedeki Date: Mon, 15 Sep 2025 19:07:10 +0200 Subject: [PATCH 2/2] * `MatloaItumeleng` added to CODEOWNERS --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 1c72e3c..a9feb8b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @Zejnilovic @dk1844 @benedeki @lsulak @yruslan +* @Zejnilovic @dk1844 @benedeki @lsulak @yruslan @MatloaItumeleng