- Overview
- Current Maintainers
- Emeritus
- Labels
- Maintainer Responsibilities
- Uphold Code of Conduct
- Prioritize Security
- Review Pull Requests
- Triage New Issues
- Triage Bug Reports
- Triage RFCs
- Releasing a new version
- Run end to end tests
- Releasing a documentation hotfix
- Maintain Overall Health of the Repo
- Manage Roadmap
- Add Continuous Integration Checks
- Negative Impact on the Project
- Becoming a maintainer
- Common scenarios
Please treat this content as a living document.
This is document explains who the maintainers are (see below), what they do in this repo, and how they should be doing it. If you're interested in contributing, see CONTRIBUTING.
| Maintainer | GitHub ID | Affiliation |
|---|---|---|
| Stephen Liedig | sliedig | Amazon |
| Amir Khairalomoum | amirkaws | Amazon |
| Henrique Graca | hjgraca | Amazon |
Previous active maintainers who contributed to this project.
| Maintainer | GitHub ID | Affiliation |
|---|---|---|
| Tiago Barbosa | t1agob | Music Tribe |
These are the most common labels used by maintainers to triage issues, pull requests (PR), and for project management:
| Label | Usage | Notes |
|---|---|---|
| triage | New issues that require maintainers review | Issue template |
| bug | Unexpected, reproducible and unintended software behavior | PR/Release automation; Doc snippets are excluded; |
| not-a-bug | New and existing bug reports incorrectly submitted as bug | Analytics |
| documentation | Documentation improvements | PR/Release automation; Doc additions, fixes, etc.; |
| feature-request | New or enhancements to existing features | Issue template |
| RFC | Technical design documents related to a feature request | Issue template |
| bug-upstream | Bug caused by upstream dependency | |
| help wanted | Tasks you want help from anyone to move forward | Bandwidth, complex topics, etc. |
| need-customer-feedback | Tasks that need more feedback before proceeding | 80/20% rule, uncertain, etc. |
| need-more-information | Missing information before making any calls | |
| need-documentation | PR is missing or has incomplete documentation | |
| need-issue | PR is missing a related issue for tracking change | Needs to be automated |
| pending-release | Merged changes that will be available soon | Release automation auto-closes/notifies it |
| revisit-in-3-months | Blocked issues/PRs that need to be revisited | Often related to need-customer-feedback, prioritization, etc. |
| breaking-change | Changes that will cause customer impact and need careful triage | |
| do-not-merge | PRs that are blocked for varying reasons | Timeline is uncertain |
| tests | PRs that add or change tests | PR automation |
area/<utility> |
PRs related to a Powertools for AWS Lambda (.NET) utility, e.g. logging, tracing |
PR automation |
| feature | New features or minor changes | PR/Release automation |
| dependencies | Changes that touch dependencies, e.g. Dependabot, etc. | PR/ automation |
| github-actions | Changes in GitHub workflows | PR automation |
| github-templates | Changes in GitHub issue/PR templates | PR automation |
| internal | Changes in governance and chores (linting setup, baseline, etc.) | PR automation |
Maintainers are active and visible members of the community, and have maintain-level permissions on a repository. Use those privileges to serve the community and evolve code as follows.
Be aware of recurring ambiguous situations and document them to help your fellow maintainers.
Model the behaviour set forward by the Code of Conduct and raise any violations to other maintainers and admins. There could be unusual circumstances where inappropriate behaviour does not immediately fall within the Code of Conduct.
These might be nuanced and should be handled with extra care - when in doubt, do not engage and reach out to other maintainers and admins.
Security is your number one priority. Maintainer's Github keys must be password protected securely and any reported security vulnerabilities are addressed before features or bugs.
Note that this repository is monitored and supported 24/7 by Amazon Security, see Reporting a Vulnerability for details.
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.
PRs are labeled based on file changes and semantic title. Pay attention to whether labels reflect the current state of the PR and correct accordingly.
Use and enforce semantic versioning pull request titles, as these will be used for CHANGELOG and Release notes - make sure they communicate their intent at the human level.
TODO: This is an area we want to automate using the new GitHub GraphQL API.
For issues linked to a PR, make sure pending-release label is applied to them when merging. Upon release, these issues will be notified which release version contains their change.
See Common scenarios section for additional guidance.
Manage 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.
TODO: This is an area we want to automate using the new GitHub GraphQL API.
Make sure issues are assigned to our board of activities and have the right status.
Use our labels to signal good first issues to new community members, and to set expectation that this might need additional feedback from the author, other customers, experienced community members and/or maintainers.
Be aware of casual contributors and recurring contributors. Provide the experience and attention you wish you had if you were starting in open source.
See Common scenarios section for additional guidance.
Be familiar with our definition of bug. If it's not a bug, you can close it or adjust its title and labels - always communicate the reason accordingly.
For bugs caused by upstream dependencies, replace bug with bug-upstream label. Ask the author whether they'd like to raise the issue upstream or if they prefer us to do so.
Assess the impact and make the call on whether we need an emergency release. Contact other maintainers when in doubt.
See Common scenarios section for additional guidance.
Releases mare managed by maintainers and follow a rigorous internal release process.
Make sure you are using the develop branch and it is up to date with the origin.
TODO: Coordinate renaming
developtomain
Keep the develop branch at production quality at all times. Backport features as needed. Cut release branches and tags to enable future patches.
See Roadmap section
Ensure the repo highlights features that should be elevated to the project roadmap. Be clear about the feature’s status, priority, target version, and whether or not it should be elevated to the roadmap.
Add integration checks that validate pull requests and pushes to ease the burden on Pull Request reviewers. Continuously revisit areas of improvement to reduce operational burden in all parties involved.
Actions that negatively impact the project will be handled by the admins, in coordination with other maintainers, in balance with the urgency of the issue. Examples would be Code of Conduct violations, deliberate harmful or malicious actions, spam, monopolization, and security risks.
These are recurring ambiguous situations that new and existing maintainers may encounter. They serve as guidance. It is up to each maintainer to follow, adjust, or handle in a different manner as long as our conduct is consistent
A contribution can get stuck often due to lack of bandwidth and language barrier. For bandwidth issues, check whether the author needs help. Make sure you get their permission before pushing code into their existing PR - do not create a new PR unless strictly necessary.
For language barrier and others, offer a 1:1 chat to get them unblocked. Often times, English might not be their primary language, and writing in public might put them off, or come across not the way they intended to be.
In other cases, you may have constrained capacity. Use help wanted label when you want to signal other maintainers and external contributors that you could use a hand to move it forward.
When in doubt, use need-more-information or need-customer-feedback labels to signal more context and feedback are necessary before proceeding. You can also use revisit-in-3-months label when you expect it might take a while to gather enough information before you can decide.
We credit all contributions as part of each release note as an automated process. If you find contributors are missing from the release note you're producing, please add them manually.
A bug produces incorrect or unexpected results at runtime that differ from its intended behaviour. Bugs must be reproducible. They directly affect customers experience at runtime despite following its recommended usage.
Documentation snippets, use of internal components, or unadvertised functionalities are not considered bugs.
Always favour mentoring issue authors to contribute, unless they're not interested or the implementation is sensitive (e.g., complexity, time to release, etc.).
Make use of help wanted and good first issue to signal additional contributions the community can help.
Try offering a 1:1 call in the attempt to get to a mutual understanding and clarify areas that maintainers could help.
In the rare cases where both parties don't have the bandwidth or expertise to continue, it's best to use the revisit-in-3-months label. By then, see if it's possible to break the PR or issue in smaller chunks, and eventually close if there is no progress.