From 27c5e8703dc476276779414f45e9572455484db1 Mon Sep 17 00:00:00 2001 From: Laurence de Bruxelles Date: Tue, 10 Aug 2021 11:39:35 +0100 Subject: [PATCH 1/2] Add tech debt issue template Adds a GitHub issue template [[1]] for tracking tech debt in the manner encouraged by the GDS Way [[2]]. This should make it slightly easier to add tech debt tickets to the repo. [1]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates [2]: https://gds-way.cloudapps.digital/standards/technical-debt.html#example --- .github/ISSUE_TEMPLATE/tech-debt.md | 32 +++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/tech-debt.md diff --git a/.github/ISSUE_TEMPLATE/tech-debt.md b/.github/ISSUE_TEMPLATE/tech-debt.md new file mode 100644 index 0000000000..148bb67758 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tech-debt.md @@ -0,0 +1,32 @@ +--- +name: "Tech debt" +about: "For internal use only - Issue template for tracking technical debt" +title: '' +labels: "tech debt, awaiting triage" +assignees: '' + +--- + + + +## Cause + +## Consequences + +## Impact of debt + + + +## Effort to pay down + + + +## Overall rating + + From d8796e8226c9a8ab446378b37fea399400287ff4 Mon Sep 17 00:00:00 2001 From: Laurence de Bruxelles Date: Mon, 16 Aug 2021 11:02:55 +0100 Subject: [PATCH 2/2] Use issue form for tech debt template As suggested by @36degrees. --- .github/ISSUE_TEMPLATE/tech-debt.md | 32 -------------- .github/ISSUE_TEMPLATE/tech-debt.yaml | 62 +++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/tech-debt.md create mode 100644 .github/ISSUE_TEMPLATE/tech-debt.yaml diff --git a/.github/ISSUE_TEMPLATE/tech-debt.md b/.github/ISSUE_TEMPLATE/tech-debt.md deleted file mode 100644 index 148bb67758..0000000000 --- a/.github/ISSUE_TEMPLATE/tech-debt.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: "Tech debt" -about: "For internal use only - Issue template for tracking technical debt" -title: '' -labels: "tech debt, awaiting triage" -assignees: '' - ---- - - - -## Cause - -## Consequences - -## Impact of debt - - - -## Effort to pay down - - - -## Overall rating - - diff --git a/.github/ISSUE_TEMPLATE/tech-debt.yaml b/.github/ISSUE_TEMPLATE/tech-debt.yaml new file mode 100644 index 0000000000..a3e1f3e063 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tech-debt.yaml @@ -0,0 +1,62 @@ +name: Tech debt +description: For internal use only - Issue template for tracking technical debt +labels: [tech debt, awaiting triage] + +body: + - type: markdown + attributes: + value: | + This is a template for creating issues that describe technical debt. + + It is based off the [example in the GDS Way page on tracking technical debt](https://gds-way.cloudapps.digital/standards/technical-debt.html#example). + + - type: textarea + attributes: + label: Cause + validations: + required: true + + - type: textarea + attributes: + label: Consequences + validations: + required: true + + - type: dropdown + attributes: + label: Impact of debt + options: [Low, Medium, High] + validations: + required: true + + - type: textarea + attributes: + label: Reason (impact of debt) + validations: + required: false + + - type: dropdown + attributes: + label: Effort to pay down + options: [Low, Medium, High] + validations: + required: true + + - type: textarea + attributes: + label: Reason (effort to pay down) + validations: + required: false + + - type: dropdown + attributes: + label: Overall rating + options: [Low, Medium, High] + validations: + required: true + + - type: textarea + attributes: + label: Reason (overall rating) + validations: + required: false