admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #4606 from MikeMcQuaid/new-maintainer-best-practises

Browse Source 
docs/New-Maintainer-Checklist: update best practises.
This commit is contained in:
Mike McQuaid 2018-08-05 12:16:00 +01:00 committed by GitHub
commit 76243269c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/New-Maintainer-Checklist.md
View File

@ -8,7 +8,7 @@ First, send them the invitation email:
``` ```
The Homebrew team and I really appreciate your help on issues, pull requests and The Homebrew team and I really appreciate your help on issues, pull requests and
your contributions around $THEIR_CONTRIBUTIONS. your contributions to Homebrew.
We would like to invite you to have commit access and be a Homebrew maintainer. We would like to invite you to have commit access and be a Homebrew maintainer.
If you agree to be a maintainer, you should spend a significant proportion of If you agree to be a maintainer, you should spend a significant proportion of
@ -17,9 +17,12 @@ issues that arise from your code in a timely fashion and reviewing user
contributions. You should also be making contributions to Homebrew every month contributions. You should also be making contributions to Homebrew every month
unless you are ill or on vacation (and please let another maintainer know if unless you are ill or on vacation (and please let another maintainer know if
that's the case so we're aware you won't be able to help while you are out). that's the case so we're aware you won't be able to help while you are out).
You will need to watch Homebrew/brew and/or Homebrew/homebrew-core. If you're
no longer able to perform all of these tasks, please continue to contribute to You will need to watch Homebrew/brew and/or Homebrew/homebrew-core. Let us know
Homebrew, but we will ask you to step down as a maintainer. which (or both) so we can grant you commit access appropriately.
If you're no longer able to perform all of these tasks, please continue to
contribute to Homebrew, but we will ask you to step down as a maintainer.
A few requests: A few requests:
@ -56,7 +59,9 @@ If they accept, follow a few steps to get them set up:
- Add them to the [Jenkins' GitHub Pull Request Builder admin list](https://jenkins.brew.sh/configure) to enable `@BrewTestBot test this please` for them - Add them to the [Jenkins' GitHub Pull Request Builder admin list](https://jenkins.brew.sh/configure) to enable `@BrewTestBot test this please` for them
- Invite them to the [`homebrew-maintainers` private maintainers mailing list](https://lists.sfconservancy.org/mailman/admin/homebrew-maintainers/members/add) - Invite them to the [`homebrew-maintainers` private maintainers mailing list](https://lists.sfconservancy.org/mailman/admin/homebrew-maintainers/members/add)
- Invite them to the [`machomebrew` private maintainers Slack](https://machomebrew.slack.com/admin/invites) (and ensure they've read the [communication guidelines](Maintainer-Guidelines.md#communication)) - Invite them to the [`machomebrew` private maintainers Slack](https://machomebrew.slack.com/admin/invites) (and ensure they've read the [communication guidelines](Maintainer-Guidelines.md#communication))
- Add them to [Homebrew's README](https://github.com/Homebrew/brew/edit/master/README.md) - Ask them to disable SMS as a 2FA device or fallback on their GitHub account in favour of using one of the other authentication methods.
- Ask them to (regularly) review remove any unneeded [GitHub personal access tokens](https://github.com/settings/tokens)
- Add them to [Homebrew/brew's README](https://github.com/Homebrew/brew/edit/master/README.md)
If they are also interested in doing system administration work: If they are also interested in doing system administration work:
@ -69,7 +74,7 @@ If they want to consume raw anonymous aggregate analytics data (rather than use
Once they have been active maintainers for at least a year and had some activity on more than one Homebrew organisation repository (or one repository and helped with system administration work): Once they have been active maintainers for at least a year and had some activity on more than one Homebrew organisation repository (or one repository and helped with system administration work):
- Homebrew's [Software Freedom Conservancy](https://sfconservancy.org) Project Leadership Committee can take a vote on whether to extend an offer to the maintainer to join the committee. If they accept, email their name, email and employer to homebrew@sfconservancy.org and make them [owners on the Homebrew GitHub organisation](https://github.com/orgs/Homebrew/people). - Homebrew's [Software Freedom Conservancy](https://sfconservancy.org) Project Leadership Committee can take a vote on whether to extend an offer to the maintainer to join the committee. If they accept, email their name, email and employer to homebrew@sfconservancy.org, make them [owners on the Homebrew GitHub organisation](https://github.com/orgs/Homebrew/people) and add them to the relevant section of the [Homebrew/brew's README](https://github.com/Homebrew/brew/edit/master/README.md).
If there are problems, ask them to step down as a maintainer and revoke their access to all of the above. If there are problems, ask them to step down as a maintainer and revoke their access to all of the above.