Skip to content

Commit 671af87

Browse files
heitorlessaheitorlessa
authored
chore(github): new tech debt issue form (#2131)
* chore: add new tech debt template Signed-off-by: heitorlessa <[email protected]> * chore: sync up maintenance template with tech debt template Signed-off-by: heitorlessa <[email protected]> * docs: add tech-debt label in maintainers playbook --------- Signed-off-by: heitorlessa <[email protected]>
1 parent 453c932 commit 671af87

File tree

3 files changed

+102
-47
lines changed

3 files changed

+102
-47
lines changed

‎.github/ISSUE_TEMPLATE/maintenance.yml

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Maintenance
2-
description: Suggest an activity to help address tech debt, governance, and anything internal
2+
description: Suggest an activity to help address governance and anything internal
33
title: "Maintenance: TITLE"
44
labels: ["internal", "triage"]
55
body:
@@ -9,13 +9,6 @@ body:
99
Thank you for taking the time to help us improve operational excellence.
1010
1111
*Future readers*: Please react with 👍 and your use case to help us understand customer demand.
12-
- type: textarea
13-
id: activity
14-
attributes:
15-
label: Summary
16-
description: Please provide an overview in one or two paragraphs
17-
validations:
18-
required: true
1912
- type: textarea
2013
id: importance
2114
attributes:
@@ -29,8 +22,6 @@ body:
2922
label: Which area does this relate to?
3023
multiple: true
3124
options:
32-
- Automation
33-
- Governance
3425
- Tests
3526
- Static typing
3627
- Tracer
@@ -41,13 +32,14 @@ body:
4132
- Middleware factory
4233
- Parameters
4334
- Batch processing
44-
- Typing
4535
- Validation
4636
- Event Source Data Classes
4737
- Parser
4838
- Idempotency
4939
- Feature flags
5040
- JMESPath functions
41+
- Streaming
42+
- Automation
5143
- Other
5244
- type: textarea
5345
id: suggestion
@@ -63,7 +55,7 @@ body:
6355
options:
6456
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-python/latest/#tenets)
6557
required: true
66-
- label: Should this be considered in other Lambda Powertools languages? i.e. [Java](https://github.com/awslabs/aws-lambda-powertools-java/), [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
58+
- label: Should this be considered in other Lambda Powertools languages? i.e. [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
6759
required: false
6860
- type: markdown
6961
attributes:

‎.github/ISSUE_TEMPLATE/tech_debt.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Technical debt
2+
description: Suggest an activity to help address technical debt.
3+
title: "Tech debt: TITLE"
4+
labels: ["tech-debt", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for taking the time to help us proactively improve delivery velocity, safely.
9+
- type: textarea
10+
id: importance
11+
attributes:
12+
label: Why is this needed?
13+
description: Please help us understand the value so we can prioritize it accordingly
14+
validations:
15+
required: true
16+
- type: dropdown
17+
id: area
18+
attributes:
19+
label: Which area does this relate to?
20+
multiple: true
21+
options:
22+
- Tests
23+
- Static typing
24+
- Tracer
25+
- Logger
26+
- Metrics
27+
- Event Handler - REST API
28+
- Event Handler - GraphQL API
29+
- Middleware factory
30+
- Parameters
31+
- Batch processing
32+
- Validation
33+
- Event Source Data Classes
34+
- Parser
35+
- Idempotency
36+
- Feature flags
37+
- JMESPath functions
38+
- Streaming
39+
- Automation
40+
- Other
41+
- type: textarea
42+
id: suggestion
43+
attributes:
44+
label: Suggestion
45+
description: If available, please share what a good solution would look like
46+
validations:
47+
required: false
48+
- type: checkboxes
49+
id: acknowledgment
50+
attributes:
51+
label: Acknowledgment
52+
options:
53+
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-python/latest/#tenets)
54+
required: true
55+
- label: Should this be considered in other Lambda Powertools languages? i.e. [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
56+
required: false
57+
- type: markdown
58+
attributes:
59+
value: |
60+
---
61+
62+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎MAINTAINERS.md

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -69,41 +69,42 @@ Previous active maintainers who contributed to this project.
6969

7070
These are the most common labels used by maintainers to triage issues, pull requests (PR), and for project management:
7171

72-
| Label | Usage | Notes |
73-
| ---------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------- |
74-
| triage | New issues that require maintainers review | Issue template |
75-
| bug | Unexpected, reproducible and unintended software behavior | PR/Release automation; Doc snippets are excluded; |
76-
| not-a-bug | New and existing bug reports incorrectly submitted as bug | Analytics |
77-
| documentation | Documentation improvements | PR/Release automation; Doc additions, fixes, etc.; |
78-
| feature-request | New or enhancements to existing features | Issue template |
79-
| typing | New or enhancements to static typing | Issue template |
80-
| RFC | Technical design documents related to a feature request | Issue template |
81-
| bug-upstream | Bug caused by upstream dependency | |
82-
| help wanted | Tasks you want help from anyone to move forward | Bandwidth, complex topics, etc. |
83-
| need-customer-feedback | Tasks that need more feedback before proceeding | 80/20% rule, uncertain, etc. |
84-
| need-more-information | Missing information before making any calls | |
85-
| need-documentation | PR is missing or has incomplete documentation | |
86-
| need-issue | PR is missing a related issue for tracking change | Needs to be automated |
87-
| need-rfc | Feature request requires a RFC to improve discussion | |
88-
| pending-release | Merged changes that will be available soon | Release automation auto-closes/notifies it |
89-
| revisit-in-3-months | Blocked issues/PRs that need to be revisited | Often related to `need-customer-feedback`, prioritization, etc. |
90-
| breaking-change | Changes that will cause customer impact and need careful triage | |
91-
| do-not-merge | PRs that are blocked for varying reasons | Timeline is uncertain |
92-
| size/XS | PRs between 0-9 LOC | PR automation |
93-
| size/S | PRs between 10-29 LOC | PR automation |
94-
| size/M | PRs between 30-99 LOC | PR automation |
95-
| size/L | PRs between 100-499 LOC | PR automation |
96-
| size/XL | PRs between 500-999 LOC, often PRs that grown with feedback | PR automation |
97-
| size/XXL | PRs with 1K+ LOC, largely documentation related | PR automation |
98-
| tests | PRs that add or change tests | PR automation |
99-
| `<utility>` | PRs related to a Powertools utility, e.g. `parameters`, `tracer` | PR automation |
100-
| feature | New features or minor changes | PR/Release automation |
101-
| dependencies | Changes that touch dependencies, e.g. Dependabot, etc. | PR/ automation |
102-
| github-actions | Changes in GitHub workflows | PR automation |
103-
| github-templates | Changes in GitHub issue/PR templates | PR automation |
104-
| internal | Changes in governance, tech debt and chores (linting setup, baseline, etc.) | PR automation |
105-
| customer-reference | Authorization to use company name in our documentation | Public Relations |
106-
| community-content | Suggested content to feature in our documentation | Public Relations |
72+
| Label | Usage | Notes |
73+
| ---------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- |
74+
| triage | New issues that require maintainers review | Issue template |
75+
| bug | Unexpected, reproducible and unintended software behavior | PR/Release automation; Doc snippets are excluded; |
76+
| not-a-bug | New and existing bug reports incorrectly submitted as bug | Analytics |
77+
| documentation | Documentation improvements | PR/Release automation; Doc additions, fixes, etc.; |
78+
| feature-request | New or enhancements to existing features | Issue template |
79+
| typing | New or enhancements to static typing | Issue template |
80+
| RFC | Technical design documents related to a feature request | Issue template |
81+
| bug-upstream | Bug caused by upstream dependency | |
82+
| help wanted | Tasks you want help from anyone to move forward | Bandwidth, complex topics, etc. |
83+
| need-customer-feedback | Tasks that need more feedback before proceeding | 80/20% rule, uncertain, etc. |
84+
| need-more-information | Missing information before making any calls | |
85+
| need-documentation | PR is missing or has incomplete documentation | |
86+
| need-issue | PR is missing a related issue for tracking change | PR automation |
87+
| need-rfc | Feature request requires a RFC to improve discussion | |
88+
| pending-release | Merged changes that will be available soon | Release automation auto-closes/notifies it |
89+
| revisit-in-3-months | Blocked issues/PRs that need to be revisited | Often related to `need-customer-feedback`, prioritization, etc. |
90+
| breaking-change | Changes that will cause customer impact and need careful triage | |
91+
| do-not-merge | PRs that are blocked for varying reasons | Timeline is uncertain |
92+
| size/XS | PRs between 0-9 LOC | PR automation |
93+
| size/S | PRs between 10-29 LOC | PR automation |
94+
| size/M | PRs between 30-99 LOC | PR automation |
95+
| size/L | PRs between 100-499 LOC | PR automation |
96+
| size/XL | PRs between 500-999 LOC, often PRs that grown with feedback | PR automation |
97+
| size/XXL | PRs with 1K+ LOC, largely documentation related | PR automation |
98+
| tests | PRs that add or change tests | PR automation |
99+
| `<utility>` | PRs related to a Powertools utility, e.g. `parameters`, `tracer` | PR automation |
100+
| feature | New features or minor changes | PR/Release automation |
101+
| dependencies | Changes that touch dependencies, e.g. Dependabot, etc. | PR/ automation |
102+
| github-actions | Changes in GitHub workflows | PR automation |
103+
| github-templates | Changes in GitHub issue/PR templates | PR automation |
104+
| internal | Changes in governance and chores (linting setup, baseline, etc.) | PR automation |
105+
| tech-debt | Changes in tech debt | |
106+
| customer-reference | Authorization to use company name in our documentation | Public Relations |
107+
| community-content | Suggested content to feature in our documentation | Public Relations |
107108

108109
## Maintainer Responsibilities
109110

0 commit comments

Comments
 (0)