From 98d712ceee7029238edda615c2f4ed808e486b53 Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Sun, 7 May 2023 18:00:49 -0400 Subject: [PATCH 1/4] Adds a TOC to the maintainer checklist and makes some minor adjustments to wordings to clarify actions to be taken when. --- docs/New-Maintainer-Checklist.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index 53d5d7d715c11..feb8df116e1c9 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -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) +- [System Owners](#owners "People with highest system privileges") +- [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! @@ -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. @@ -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 @@ -83,17 +92,17 @@ 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 +## System Owners -The Project Leader, one other PLC member (ideally a maintainer) and one other TSC member should be made owners on GitHub and Slack: +The Project Leader, one other PLC member (ideally a maintainer) and one other TSC member should be made system owners on GitHub and Slack: - Make them owners on the [Homebrew GitHub organisation](https://github.com/orgs/Homebrew/people) - 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 a system owner, revoke or downgrade their access to all of the above. ## Members @@ -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. From 38adddbda70033dfe591f301a607615424ea26f9 Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Tue, 9 May 2023 09:04:54 -0400 Subject: [PATCH 2/4] Restore Owners header My intent was to disambiguate what ownership means and be specific but we decided it was better to just keep the title the same since that's what it's called in all of the systems. --- docs/New-Maintainer-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index feb8df116e1c9..53e4000112372 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -94,7 +94,7 @@ If a maintainer is elected to the Homebrew's [Technical Steering Committee](http When they cease to be a TSC member, revoke or downgrade their access to all of the above. -## System Owners +## Owners The Project Leader, one other PLC member (ideally a maintainer) and one other TSC member should be made system owners on GitHub and Slack: From 123437f05e7c8e6a93df59ec8d223b0f5c3b1eed Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Tue, 9 May 2023 21:15:11 -0400 Subject: [PATCH 3/4] Sync 'owners' in TOC in New Maintainers Checklist --- docs/New-Maintainer-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index 53e4000112372..3fa180ee7fc30 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -6,7 +6,7 @@ - [Homebrew Maintainers](#maintainers) - [Project Leadership Committee](#plc) - [Technical Steering Committee](#tsc) -- [System Owners](#owners "People with highest system privileges") +- [Owners](#owners "People with highest system privileges") - [General Members](#members) ## Maintainers From 17562724bdaec4ff32878d081aba778d055d95e8 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Wed, 10 May 2023 12:56:15 +0100 Subject: [PATCH 4/4] New-Maintainer-Checklist: cleanup owners references. --- docs/New-Maintainer-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index 3fa180ee7fc30..4a7a5e45621fe 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -6,7 +6,7 @@ - [Homebrew Maintainers](#maintainers) - [Project Leadership Committee](#plc) - [Technical Steering Committee](#tsc) -- [Owners](#owners "People with highest system privileges") +- [Owners](#owners) - [General Members](#members) ## Maintainers @@ -96,13 +96,13 @@ When they cease to be a TSC member, revoke or downgrade their access to all of t ## Owners -The Project Leader, one other PLC member (ideally a maintainer) and one other TSC member should be made system owners on GitHub and Slack: +The Project Leader, one other PLC member (ideally a maintainer) and one other TSC member should be made owners on GitHub and Slack: - Make them owners on the [Homebrew GitHub organisation](https://github.com/orgs/Homebrew/people) - 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 cease to be a system 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