Skip to content

Commit

Permalink
Issue Template (DEBT.yml)
Browse files Browse the repository at this point in the history
  • Loading branch information
meltwater-ateam committed Sep 25, 2023
1 parent d988036 commit c43236f
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/DEBT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# Automatically Generated File, DO NOT MODIFY (Maintained By Terraform)
# Code: github.com/meltwater/foundation-github/blob/main/foundation/
name: Technical Debt
description: Report technical debt to A-Team
title: "[Debt] Could Be Better"
labels: tech-debt
body:
- type: markdown
attributes:
value: |
## Please search to see if an issue already exists for the technical debt you encountered...
- type: textarea
id: description
attributes:
label: Debt Description
description: Technical debt can include architecture, code, documentation, infrastructure, process, services, tests or more. Ideally we are looking for some problem, inefficiency, trade-off or obsoleted _thing_ that needs to be addressed before we can achieve engineering excellence...
validations:
required: true
- type: textarea
id: code
attributes:
label: Code / Process Detail
description: |
Having code / process references is imperative to ensure all of the technical debt is addressed...
> **Pro Tip**: Select a block of code (using line numbers), choose 'Copy permalink' from the ellipsis menu and paste into the report text to create a full great codeblock and file reference. Here is [more information](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet) on how this works.
value: |
1.
validations:
required: true
- type: markdown
attributes:
value: |
> **NOTICE**: This issue will automatically be associated with the [A-Team Debt, Bugs & OSS](https://github.com/orgs/meltwater/projects/64) for prioritization.

0 comments on commit c43236f

Please sign in to comment.