Skip to content

Commit 77504dc

Browse files
heitorlessaheitorlessa
authored
chore(governance): add new maintenance issue template for tech debt (#1326)
1 parent cad96a6 commit 77504dc

File tree

2 files changed

+106
-33
lines changed

2 files changed

+106
-33
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/maintenance.yml

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Maintenance
2+
description: Suggest an activity to help address tech debt, governance, and anything internal
3+
title: "Maintenance: TITLE"
4+
labels: ["internal", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to help us improve operational excellence.
10+
11+
*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: Technical debt
16+
description: Please provide an overview in one or two paragraphs
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: importance
21+
attributes:
22+
label: Why is this needed?
23+
description: Please help us understand the value so we can prioritize it accordingly
24+
validations:
25+
required: true
26+
- type: dropdown
27+
id: area
28+
attributes:
29+
label: Which area does this relate to?
30+
multiple: true
31+
options:
32+
- Automation
33+
- Governance
34+
- Tests
35+
- Static typing
36+
- Tracer
37+
- Logger
38+
- Metrics
39+
- Event Handler - REST API
40+
- Event Handler - GraphQL API
41+
- Middleware factory
42+
- Parameters
43+
- Batch processing
44+
- Typing
45+
- Validation
46+
- Event Source Data Classes
47+
- Parser
48+
- Idempotency
49+
- Feature flags
50+
- JMESPath functions
51+
- Other
52+
- type: textarea
53+
id: suggestion
54+
attributes:
55+
label: Solution
56+
description: If available, please share what a good solution would look like
57+
validations:
58+
required: false
59+
- type: checkboxes
60+
id: acknowledgment
61+
attributes:
62+
label: Acknowledgment
63+
options:
64+
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-python/latest/#tenets)
65+
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/)
67+
required: false
68+
- type: markdown
69+
attributes:
70+
value: |
71+
---
72+
73+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Diff for: ‎MAINTAINERS.md

+33-33
Original file line numberDiff line numberDiff line change
@@ -57,39 +57,39 @@ Previous active maintainers who contributed to this project.
5757

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

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

9494
## Maintainer Responsibilities
9595

0 commit comments

Comments
 (0)