Skip to content

Commit f205008

Browse files
committed
docs(maintainers): add PR and issue triage
1 parent 4e78d67 commit f205008

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

MAINTAINERS.md

+31-5
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
- [Contribution is stuck](#contribution-is-stuck)
2424
- [Insufficient feedback or information](#insufficient-feedback-or-information)
2525
- [Crediting contributions](#crediting-contributions)
26+
- [Inviting contributions](#inviting-contributions)
27+
- [Long running issues or PRs](#long-running-issues-or-prs)
2628

2729
## Overview
2830

@@ -101,23 +103,39 @@ Note that this repository is monitored and supported 24/7 by Amazon Security, se
101103

102104
### Review Pull Requests
103105

104-
> WORK-IN-PROGRESS
105-
> TODO: cover labels, CI automation, the right to close, and a reference to FAQ on common issues.
106-
107106
Review pull requests regularly, comment, suggest, reject, merge and close. Accept only high quality pull-requests. Provide code reviews and guidance on incoming pull requests.
108107

108+
PRs are automatically [labelled](#labels) based on file changes and semantic title. Pay attention to whether labels reflect the current state of the PR and correct accordingly.
109+
109110
Use and enforce [semantic versioning](https://semver.org/) pull request titles, as these will be used for [CHANGELOG](CHANGELOG.md) and [Release notes](https://github.com/awslabs/aws-lambda-powertools-python/releases) - make sure they communicate their intent at human level.
110111

112+
> TODO: This is an area we want to automate using the new GitHub GraphQL API.
113+
114+
For issues linked to a PR, make sure `pending release` label is applied to them when merging. Upon release, all issues with that label will be notified which version contains that change.
115+
116+
See [Common scenarios](#common-scenarios) section for additional guidance.
117+
111118
### Triage New Issues
112119

113-
> WORK-IN-PROGRESS
114-
> TODO: cover labels, reference to Roadmap Project Status definition, sensitive labels to defer or prioritize work, and give first priority to original authors on implementation
120+
Manage [labels](#labels), review issues regularly, and create new labels as needed by the project. Remove `triage` label when you're able to confirm the validity of a request, a bug can be reproduced, etc. Give priority to the original author for implementation, unless it is a sensitive task that is best handled by maintainers.
121+
122+
> TODO: This is an area we want to automate using the new GitHub GraphQL API.
123+
124+
Make sure issues are assigned to our [board of activities](https://github.com/orgs/awslabs/projects/51/) and have the appropriate [status](https://awslabs.github.io/aws-lambda-powertools-python/latest/roadmap/#roadmap-status-definition).
125+
126+
Use our [labels](#labels) to signal good first issues to new community members, and to set expectation that this might require additional feedback from the author, other customers, experienced community members and/or maintainers.
127+
128+
Be aware of [casual contributors](https://opensource.com/article/17/10/managing-casual-contributors) and recurring contributors. Provide the experience and attention you wish you had if you were starting in open source.
129+
130+
See [Common scenarios](#common-scenarios) section for additional guidance.
115131

116132
### Triage Bug Reports
117133

118134
> WORK-IN-PROGRESS
119135
> TODO: cover different types of bugs (internal, customer-facing, upstream), reference to releasing section
120136
137+
See [Common scenarios](#common-scenarios) section for additional guidance.
138+
121139
### Triage RFCs
122140

123141
RFCs are meant to be a collaborative process to help us get to the most optimal solution given the context. Their purpose is to ensure everyone understands what this context is, their trade-offs, and alternative solutions that were part of the research before implementation begins.
@@ -189,3 +207,11 @@ When in doubt, use `need-more-information` or `need-customer-feedback` labels to
189207
### Crediting contributions
190208

191209
> TODO: mention release notes and provide an example.
210+
211+
### Inviting contributions
212+
213+
> TODO: sensitive labels to defer or prioritize work
214+
215+
### Long running issues or PRs
216+
217+
> TODO: Suggesting 1:1 or group calls, break XXL PRs in smaller chunks and different priorities, etc.

0 commit comments

Comments
 (0)