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.

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

Adds a TOC to the maintainer checklist #15376

Merged
merged 4 commits into from
May 10, 2023
Merged
Changes from all commits
Commits
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
21 changes: 16 additions & 5 deletions docs/New-Maintainer-Checklist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# New Maintainer Checklist

**This is a guide used by existing maintainers to invite new maintainers. You might find it interesting but there's nothing here users should have to know.**
**Existing maintainers and project leadership uses this guide to invite and onboard new maintainers and project leaders.**
**General Homebrew users might find it interesting but there's nothing here _users_ should have to know.**

- [Homebrew Maintainers](#maintainers)
- [Project Leadership Committee](#plc)
- [Technical Steering Committee](#tsc)
- [Owners](#owners)
- [General Members](#members)

## Maintainers

There's someone who has been making consistently high-quality contributions to Homebrew and shown themselves able to make slightly more advanced contributions than just e.g. formula updates? Let's invite them to be a maintainer!

Expand Down Expand Up @@ -60,7 +69,7 @@ If they accept, follow a few steps to get them set up:

If there are problems, ask them to step down as a maintainer.

When they step down as a maintainer for any reason, revoke their access to all of the above.
When they cease to be a maintainer for any reason, revoke their access to all of the above.

In the interests of loosely verifying maintainer identity and building camaraderie, if you find yourself in the same town (e.g living, visiting or at a conference) as another Homebrew maintainer you should make the effort to meet up. If you do so, you can [expense your meal](https://docs.opencollective.com/help/expenses-and-getting-paid/submitting-expenses) (within [Homebrew's reimbursable expense policies](https://opencollective.com/homebrew/expenses)). This is a more relaxed version of similar policies used by other projects, e.g. the Debian system to meet in person to sign keys with legal ID verification.

Expand All @@ -74,7 +83,7 @@ If a maintainer or member is elected to the Homebrew's [Project Leadership Commi
- Make them [billing managers](https://github.com/organizations/Homebrew/settings/billing) and [moderators](https://github.com/organizations/Homebrew/settings/moderators) on the Homebrew GitHub organisation
- Invite them to the [`homebrew` private 1Password](https://homebrew.1password.com/people) and add them to the "plc" group.

When they step down as a PLC member, revoke or downgrade their access to all of the above.
When they cease to be a PLC member, revoke or downgrade their access to all of the above.

## TSC

Expand All @@ -83,7 +92,7 @@ If a maintainer is elected to the Homebrew's [Technical Steering Committee](http
- Invite them to the [**@Homebrew/tsc** team](https://github.com/orgs/Homebrew/teams/tsc/members)
- Make them [billing managers](https://github.com/organizations/Homebrew/settings/billing) and [moderators](https://github.com/organizations/Homebrew/settings/moderators) on the Homebrew GitHub organisation

When they step down as a TSC member, revoke or downgrade their access to all of the above.
When they cease to be a TSC member, revoke or downgrade their access to all of the above.

## Owners

Expand All @@ -93,7 +102,7 @@ The Project Leader, one other PLC member (ideally a maintainer) and one other TS
- Make them owners on the [`machomebrew` private Slack](https://machomebrew.slack.com/admin)
- Make them owners on the [`homebrew` private 1Password](https://homebrew.1password.com/people)

When they step down as an owner, revoke or downgrade their access to all of the above.
When they cease to be am owner, revoke or downgrade their access to all of the above.

## Members

Expand All @@ -112,3 +121,5 @@ If they are interested in doing ops/infrastructure/system administration work:
If they are interested in doing security work:

- Invite them to the [`homebrew` private 1Password](https://homebrew.1password.com/people) and add them to the "security" group.

See [Homebrew Governance](Homebrew-Governance.md) for when an individual's membership expires.