2022-12-01 12:52:01 -05:00
|
|
|
# Maintainer responsibilities
|
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
## Join the team meetings
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
Participate in the regular team meetings, see [meeting information and protocol] for details.
|
|
|
|
|
|
|
|
[meeting information and protocol]: ./README.md#team-meetings
|
|
|
|
|
|
|
|
If you can't participate, notify other team members.
|
|
|
|
|
|
|
|
## Stay informed
|
|
|
|
|
|
|
|
Follow relevant activities on these communication channels:
|
2022-12-01 12:52:01 -05:00
|
|
|
|
|
|
|
- GitHub
|
2022-12-01 17:34:40 -05:00
|
|
|
|
|
|
|
Subscribe to issues and pull requests you care about.
|
|
|
|
|
2022-12-01 12:52:01 -05:00
|
|
|
- Discourse
|
2022-12-01 17:34:40 -05:00
|
|
|
|
|
|
|
Set the notification level on the [Development > Documentation] Discourse category to "watching".
|
|
|
|
|
|
|
|
[Development > Documentation]: https://discourse.nixos.org/c/dev/documentation/25
|
|
|
|
|
2022-12-01 12:52:01 -05:00
|
|
|
- Matrix
|
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
Join the [Nix\* Documentation] Matrix room and enable relevant notifications.
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
[Nix\* Documentation]: https://matrix.to/#/#docs:nixos.org
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
## Take ownership
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
Maintain your entry in the [`CODEOWNERS`] file in the respective repository.
|
|
|
|
GitHub will then request reviews for pull requests that change files you own.
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
[`CODEOWNERS`]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
As a maintainer, you are responsible for the code you approve and merge.
|
|
|
|
Make sure to follow up on bugs and regressions in the code you maintain.
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
Respond to `@` mentions on GitHub, Discourse, and Matrix within reasonable time.
|
|
|
|
Notify readers if you cannot deal with the issue due to time constraints or other priorities.
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
Make sure to reserve time for reviewing pull requests that fall within your area of interest or expertise.
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
## Provide guidance
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
Guide potential contributors:
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
- help answering questions on the [Discourse Help category]
|
|
|
|
- encourage question authors to raise or upvote issues on GitHub, if needed
|
|
|
|
- assist them with making pull requests to solve the underlying problems, if possible
|
2022-12-01 12:52:01 -05:00
|
|
|
|
2022-12-01 17:34:40 -05:00
|
|
|
[Discourse Help category]: https://discourse.nixos.org/c/learn/9
|