Skip to content

Latest commit

 

History

History
95 lines (79 loc) · 4.57 KB

MAINTAINERS.md

File metadata and controls

95 lines (79 loc) · 4.57 KB
Raw

rust-vmm maintainers

In rust-vmm we have two types of maintainers:

  • gatekeepers that have admin permissions over all rust-vmm repositories, and are responsible for the general health of the project.
  • repository maintainer that have admin permissions and are responsible for the health of one or more rust-vmm repositories.

Note that we do not have a process for removing maintainers and gatekeepers. This means that not all the people mentioned in this document might still be active in the project.

Repository Maintainer

As a repository maintainer you have the following responsibilities:

  • review PRs coming from the open source community
  • respond to issues/questions
  • review the dependabot PRs and fix any problems that are generated by updates in rust-vmm-ci (typically clippy fixes are required when updating the Rust version) or other dependencies
  • updating the rust-vmm-ci manually when updates are needed before the dependabot scheduled time.
  • make sure that the quality guidelines are followed before publishing a new crate or a new version.
  • follow the crate release process for publishing new crate versions

The repository maintainers are mentioned in the CODEOWNERS file of all rust-vmm repositories.

Becoming a Repository Maintainer

As the project is evolving we are looking to add repository maintainers. We encourage people to first ramp up on the repositories by going through the documentation, looking at issues, review and submit pull requests. Even though you initially do not have write permissions for the repository, reviews are a great way to get familiar with the code.

Once you feel confident about the code in the repository, you can become a maintainer using the following guidelines:

  1. To be a code owner, open a PR in the target repository, edit the CODEOWNERS file and add your GitHub handle there. In case you want to add someone else as a code owner, open a PR in the target repository, add their GitHub handle in the CODEOWNERS file, and ask that person to formally approve the PR as acknowledgement that they agree with the role.
  2. Irrespective of who created the PR, all existing code owners (as defined in theCODEOWNERS file) must approve the PR before it is merged. In case there are no code owners in the repository, ask 2 gatekeepers to approve the PR for you.
  3. Once the PR is merged, ask one of the existing code owners to grant you admin permissions to the repository following the GitHub guide. Note that maintainers can also be granted Admin rights, if they need permissions to update the repository settings (such as adding a member).
  4. Repository Maintainers are responsible for creating releases. For crates that are published to crates.io the release process includes publishing a new version. Ask one of the maintainers to give you permissions for the crate on crates.io.

The Gatekeeper Role

The wider organization is managed by a team gatekeepers 🔒, which is viewable only by rust-vmm organization members. For those outside the organization a snapshot of the membership is available below.

Gatekeepers may get assigned as PR reviewers when a rust-vmm repository is lacking code owners, or when a previously assigned reviewer is not able to review a pending PR.

If you want to adopt repsonsibility to help with the project, it is preferable to become a repository maintainers instead.

List of Gatekeepers1

Footnotes

  1. As of 2024/03/21 ↩