|
| 1 | + |
| 2 | +## Table of contents <!-- omit in toc --> |
| 3 | + |
| 4 | +- [Overview](#overview) |
| 5 | +- [Current Maintainers](#current-maintainers) |
| 6 | +- [Emeritus](#emeritus) |
| 7 | +- [Maintainer Responsibilities](#maintainer-responsibilities) |
| 8 | + - [Uphold Code of Conduct](#uphold-code-of-conduct) |
| 9 | + - [Prioritize Security](#prioritize-security) |
| 10 | + - [Review Pull Requests](#review-pull-requests) |
| 11 | + - [Triage Open Issues](#triage-open-issues) |
| 12 | + - [Triage Bug Reports](#triage-bug-reports) |
| 13 | + - [Releasing a new version](#releasing-a-new-version) |
| 14 | + - [Releasing a documentation hotfix](#releasing-a-documentation-hotfix) |
| 15 | + - [Maintain Overall Health of the Repo](#maintain-overall-health-of-the-repo) |
| 16 | + - [Manage Roadmap](#manage-roadmap) |
| 17 | + - [Add Continuous Integration Checks](#add-continuous-integration-checks) |
| 18 | + - [Negative Impact on the Project](#negative-impact-on-the-project) |
| 19 | + - [Becoming a maintainer](#becoming-a-maintainer) |
| 20 | + |
| 21 | +## Overview |
| 22 | + |
| 23 | +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](CONTRIBUTING.md). |
| 24 | + |
| 25 | +## Current Maintainers |
| 26 | + |
| 27 | +| Maintainer | GitHub ID | Affiliation | |
| 28 | +| ---------------- | --------------------------------------------- | ----------- | |
| 29 | +| Heitor Lessa | [heitorlessa](https://github.com/heitorlessa) | Amazon | |
| 30 | +| Alexander Melnyk | [am29d](https://github.com/am29d) | Amazon | |
| 31 | +| Michal Ploski | [mploski](https://github.com/mploski) | Amazon | |
| 32 | +| Simon Thulbourn | [sthulb](https://github.com/sthulb) | Amazon | |
| 33 | + |
| 34 | +## Emeritus |
| 35 | + |
| 36 | +Previous active maintainers who contributed to this project. |
| 37 | + |
| 38 | +| Maintainer | GitHub ID | Affiliation | |
| 39 | +| ----------------- | ----------------------------------------------- | ----------- | |
| 40 | +| Tom McCarthy | [cakepietoast](https://github.com/cakepietoast) | MongoDB | |
| 41 | +| Nicolas Moutschen | [nmoutschen](https://github.com/nmoutschen) | Amazon | |
| 42 | + |
| 43 | +## Maintainer Responsibilities |
| 44 | + |
| 45 | +Maintainers are active and visible members of the community, and have [maintain-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and evolve code as follows. |
| 46 | + |
| 47 | +### Uphold Code of Conduct |
| 48 | + |
| 49 | +Model the behavior set forward by the [Code of Conduct](CODE_OF_CONDUCT.md) and raise any violations to other maintainers and admins. There could be unusual circumstances where inappropriate behavior does not immediately fall within the [Code of Conduct](CODE_OF_CONDUCT.md). These might be nuanced and should be handled with extra care - do not engage, whenever in doubt reach out to other maintainers and admins. |
| 50 | + |
| 51 | +### Prioritize Security |
| 52 | + |
| 53 | +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. |
| 54 | + |
| 55 | +Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details. |
| 56 | + |
| 57 | +### Review Pull Requests |
| 58 | + |
| 59 | +> WORK-IN-PROGRESS |
| 60 | +> TODO: cover labels, CI automation, the right to close, and a reference to FAQ on common issues. |
| 61 | +
|
| 62 | +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. |
| 63 | + |
| 64 | +Use and enforce [semantic versioning](https://semver.org/) pull request titles, as these will be used for [CHANGELOG](CHANGELOG.md) and Release notes - make sure they communicate their intent at human level. |
| 65 | + |
| 66 | +### Triage Open Issues |
| 67 | + |
| 68 | +> WORK-IN-PROGRESS |
| 69 | +> TODO: cover labels, reference to Roadmap Project Status definition, sensitive labels to defer or prioritize work |
| 70 | +
|
| 71 | +### Triage Bug Reports |
| 72 | + |
| 73 | +> WORK-IN-PROGRESS |
| 74 | +> TODO: cover different types of bugs (internal, customer-facing, upstream), reference to releasing section |
| 75 | +
|
| 76 | +### Releasing a new version |
| 77 | + |
| 78 | +> WORK-IN-PROGRESS |
| 79 | +> convert what's written in [publish.yml](.github/workflows/publish.yml) |
| 80 | +
|
| 81 | +### Releasing a documentation hotfix |
| 82 | + |
| 83 | +> WORK-IN-PROGRESS |
| 84 | +> convert what's written in [publish.yml](.github/workflows/publish.yml) |
| 85 | +
|
| 86 | +### Maintain Overall Health of the Repo |
| 87 | + |
| 88 | +Keep the `develop` branch at production quality at all times. Backport features as needed. Cut release branches and tags to enable future patches. |
| 89 | + |
| 90 | +### Manage Roadmap |
| 91 | + |
| 92 | +See [Roadmap section](https://awslabs.github.io/aws-lambda-powertools-python/latest/roadmap/) |
| 93 | + |
| 94 | +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. |
| 95 | + |
| 96 | +### Add Continuous Integration Checks |
| 97 | + |
| 98 | +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. |
| 99 | + |
| 100 | +### Negative Impact on the Project |
| 101 | + |
| 102 | +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](CODE_OF_CONDUCT.md) violations, deliberate harmful or malicious actions, and security risks. |
| 103 | + |
| 104 | +### Becoming a maintainer |
| 105 | + |
| 106 | +> WORK-IN-PROGRESS |
| 107 | +> TODO: cover ideas of what a future process might look like for when we're ready to do it fairly and securely. |
0 commit comments