Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

complete the overview of maintainer responsibilities #403

Merged
merged 1 commit into from
Dec 1, 2022
Merged

complete the overview of maintainer responsibilities #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions maintainers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,22 @@ Ordered by priority:
- moderate and keep schedule
- take and publish notes

## Meeting protocol
## Team meetings

The team holds meetings every second Thursday 17:30-18:30 (Europe/Berlin):
The team holds weekly meetings on Thursdays 17:30-18:30 (Europe/Berlin):
- [NixOS calendar](https://calendar.google.com/calendar/u/0/embed?src=b9o52fobqjak8oq8lfkhg3t0qg@group.calendar.google.com)
- [Discourse community calendar](https://discourse.nixos.org/t/community-calendar/18589)

### Meeting links

- [Jitsi conference](https://meet.jit.si/nix-documentation)
- [Meeting notes scratchad](https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA)
- [GitHub project board](https://github.com/orgs/NixOS/projects/15)

[Previous meeting notes](https://discourse.nixos.org/search?q=documentation%20team%20meeting%20%23dev%3Adocumentation%20order%3Alatest)

### Meeting protocol

The purpose of the meetings is to
- make strategic decisions
- coordinate efforts
Expand Down
60 changes: 35 additions & 25 deletions maintainers/responsibilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,54 @@
# Maintainer responsibilities

## Monitor notifications
## Join the team meetings

Watch discussions and proposals from these communication channels:
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:

- GitHub

Subscribe to issues and pull requests you care about.

- Discourse

Set the notification level on the [Development > Documentation] Discourse category to "watching".

[Development > Documentation]: https://discourse.nixos.org/c/dev/documentation/25

- 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.
Join the [Nix\* Documentation] Matrix room and enable relevant notifications.

[Nix\* Documentation]: https://matrix.to/#/#docs:nixos.org

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

Join the [Nix* Documentation](https://matrix.to/#/#docs:nixos.org) Matrix room and enable relevant notifications.
Maintain your entry in the [`CODEOWNERS`] file in the respective repository.
GitHub will then request reviews for pull requests that change files you own.

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.
[`CODEOWNERS`]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

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.
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.

## Provide guidance
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.

As a maintainer, you will have to guide potential contributors.
Make sure to reserve time for reviewing pull requests that fall within your area of interest or expertise.

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.
## Provide guidance

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.
Guide potential contributors:

## Take ownership of issues, pull requests, and source code
- 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

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.
[Discourse Help category]: https://discourse.nixos.org/c/learn/9