Skip to content

Commit

Permalink
Maintainer responsibilities (NixOS#362)
Browse files Browse the repository at this point in the history
maintainers: document responsibilities

as discussed by documentation team

Co-authored-by: Silvan Mosberger <github@infinisil.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Emilia Bopp <contact@ebopp.de>
Co-authored-by: Luc Perkins <luc.perkins@determinate.systems>
  • Loading branch information
5 people committed Dec 1, 2022
1 parent fa6aebe commit b342497
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions maintainers/responsibilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Maintainer responsibilities

## Monitor notifications

Watch discussions and proposals from these communication channels:

- GitHub
- Discourse
- Matrix

Maintain your entry in the [`CODEOWNERS`](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file in the respective repository.
GitHub will then request reviews for pull requests that change files you own.


Set the notification level on the [Development > Documentation](https://discourse.nixos.org/c/dev/documentation/25) Discourse category to "watching".

Join the [Nix* Documentation](https://matrix.to/#/#docs:nixos.org) Matrix room and enable relevant notifications.

As a maintainer, you have the responsibility to be responsive to `@` mentions
on GitHub, Discourse, and Matrix. If said mention is low on your priority list,
you can respond by saying that.

Finally, you should also make sure to subscribe to external resources that
falls into your area. For example, if you are a maintainer of the documentation
team, you need to be aware of the stabilisation status of Nix features. If you
are a maintainer of the security team, you need to be subscribed to CVE
publications.

## Provide guidance

As a maintainer, you will have to guide potential contributors.

This can be done by taking questions from the Discourse forum, and encouraging
the poster to write issues on GitHub, if needed, and then guide them to write
Pull Requests.

In any case, make sure to reserve time for doing Pull Request reviews, and to
only pick subjects that fall withing files that are in your `CODEOWNERS` entry.

## Take ownership of issues, pull requests, and source code

As a maintainer, you are responsible for the code you approve and merge: it is
also your responsibility to follow-up on bugs and regressions caused by this
code.

0 comments on commit b342497

Please sign in to comment.