Skip to content

Commit 6ad22c2

Browse files
chore: add issue template for technical debt (llamastack#2753)
# What does this PR do? Adds a template for technical debt. Currently we don't support blank issues so everything filed has to a bug or a feature. This would allow maintainers as well as community members to track things we might want to merge to expose the functionality but should be addressed later. Such things can also be "good first issues" for new contributors. ## Example of what we constitute as technical debt Inelegant code solutions, tests we intend to temporarily disable but would like to restore, CI hacks around infrastructure or installation, etc. Signed-off-by: Nathan Weinberg <[email protected]>
1 parent aa0840c commit 6ad22c2

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 🔧 Tech Debt
2+
description: Something that is functional but should be improved or optimizied
3+
labels: ["tech-debt"]
4+
body:
5+
- type: textarea
6+
id: tech-debt-explanation
7+
attributes:
8+
label: 🤔 What is the technical debt you think should be addressed?
9+
description: >
10+
A clear and concise description of _what_ needs to be addressed - ensure you are describing
11+
constitutes [technical debt](https://en.wikipedia.org/wiki/Technical_debt) and is not a bug
12+
or feature request.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: tech-debt-motivation
18+
attributes:
19+
label: 💡 What is the benefit of addressing this technical debt?
20+
description: >
21+
A clear and concise description of _why_ this work is needed.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: other-thoughts
27+
attributes:
28+
label: Other thoughts
29+
description: >
30+
Any thoughts about how this may result in complexity in the codebase, or other trade-offs.

0 commit comments

Comments
 (0)