diff --git a/docs/collaboration-infrastructure.mdx b/docs/collaboration-infrastructure.mdx index c6927769..6ee43f7a 100644 --- a/docs/collaboration-infrastructure.mdx +++ b/docs/collaboration-infrastructure.mdx @@ -310,7 +310,8 @@ In order to consolidate processes and tools around security vulnerabilities mana 3. A [LICENSE template](https://github.com/finos/software-project-blueprint/blob/master/LICENSE), required by FINOS bylaws 4. A [Code of Conduct](https://github.com/finos/software-project-blueprint/blob/master/.github/CODE_OF_CONDUCT.md) template, required by FINOS bylaws 5. [Contributing guidelines](https://github.com/finos/software-project-blueprint/blob/master/CONTRIBUTING.md), required by FINOS bylaws -6. Issue templates for bugs, feature requests and support questions , [defined in the `.github` folder](https://github.com/finos/software-project-blueprint/tree/master/.github/ISSUE_TEMPLATE) +6. A [MAINTAINERS.md](https://github.com/finos/software-project-blueprint/blob/main/MAINTAINERS.md) file in the repository root, listing the current project maintainers +7. Issue templates for bugs, feature requests and support questions , [defined in the `.github` folder](https://github.com/finos/software-project-blueprint/tree/master/.github/ISSUE_TEMPLATE) Placeholders are defined using the `{}` brackets. diff --git a/docs/finos-maintainer-cheatsheet.mdx b/docs/finos-maintainer-cheatsheet.mdx index fa4b9072..268a078c 100644 --- a/docs/finos-maintainer-cheatsheet.mdx +++ b/docs/finos-maintainer-cheatsheet.mdx @@ -28,6 +28,20 @@ It is possible, and advised, that projects have multiple maintainers, in which c FINOS Standards projects can also have [**editors**](https://github.com/finos/standards-project-blueprint/blob/master/governance-documents/5._Governance.md#1roles). +## MAINTAINERS.md file + +Every FINOS repository is expected to include a root-level `MAINTAINERS.md` file that clearly identifies the current project maintainers. The file gives contributors a consistent place to find who can review contributions, provide project guidance, and make or coordinate project decisions. + +Project maintainers are responsible for keeping the `MAINTAINERS.md` file accurate and up to date. Each maintainer entry should include the maintainer's GitHub username, name, organization, and email address. Keeping this information visible supports open governance, gives public recognition to the people and organizations sustaining the project, and helps FINOS and Linux Foundation projects maintain a transparent record of project leadership. + +All changes to the maintainer list must be managed openly: + +- Submit a Pull Request to `MAINTAINERS.md` for any maintainer addition, removal, or update. +- If the project's governance requires a vote for maintainer changes, document or link to the vote outcome in the PR description or comments. +- Use the PR history as the public audit trail for project leadership changes over time. + +Please email [help@finos.org](mailto:help@finos.org) whenever `MAINTAINERS.md` is updated with a change to maintainership. + ## Maintainer responsibilities and available resources FINOS project maintainers are responsible for technical & subject matter oversight of the project, and for driving community growth and engagement. FINOS supports project maintainers and their project communities through: @@ -43,6 +57,7 @@ The below table lists maintainers' responsibilities and available resources. Ple |:---|:---| | **Grow project maturity and community** | Virtually all FINOS hosted projects are expected to strive towards, and ultimately attain, [Graduated status](/docs/governance/lifecycle-stages/graduated). The FINOS team supports projects in this journey through: | | **Run Project Meetings** | Project maintainers are welcome to engage with their project community through project meetings. If they choose to do so, maintainers are responsible for creating meeting agendas, recording meeting attendance and publishing meeting minutes. | +| **Maintain project leadership records** | Maintainers are responsible for keeping the root-level `MAINTAINERS.md` file accurate and up to date. FINOS supports this by providing a standard `MAINTAINERS.md` template, opening rollout PRs where possible, and helping projects resolve questions about format or process via [help@finos.org](mailto:help@finos.org). Any addition, removal, or update should be proposed through a Pull Request, with any required vote outcome documented or linked in the PR. | | **CI/CD** | Project maintainers are responsible for integrating Continuous Integration and Continuous Deployment into their FINOS project builds: | | **Documentation** | Maintainers are responsible for publishing project documentation from their project's GitHub Repositories to FINOS Project Websites. | | **Security** | Maintainers are responsible for preventing, discovering and responsibly disclosing Security Vulnerability Issues as they affect their projects |