mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update new maintainer checklist

Browse Source
This commit is contained in:
Rylan Polster 2021-05-18 02:39:57 -04:00
parent 46af59fe3a
commit ac6b4dbe6e
No known key found for this signature in database
GPG Key ID: 46A744940CFF4D64
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,28 +26,24 @@ contribute to Homebrew, but we will ask you to step down as a maintainer.
A few requests: A few requests:
- Please make pull requests on any changes to Homebrew/brew code or any - Please make pull requests for any changes in the Homebrew repositories (instead
non-trivial (e.g. not a test or audit improvement or version bump) changes of committing directly) and don't merge them unless you get at least one approval
to formulae code and don't merge them unless you get at least one approval
and passing tests. and passing tests.
- In Homebrew/brew, close pull requests using GitHub's "Merge pull request" - Please review the Maintainer Guidelines at https://docs.brew.sh/Maintainer-Guidelines
button in "Create a merge commit" mode. - Please review the team-specific guides for whichever teams you will be a part of.
- In Homebrew/homebrew-core, use `brew pr-publish` to close pull requests Here are links to these guides:
that require new bottles or change multiple formulae. Note that an approving - Homebrew/brew: https://docs.brew.sh/Homebrew-brew-Maintainer-Guide
review on a pull request for an existing formula will trigger this automatically. - Homebrew/homebrew-core: https://docs.brew.sh/Homebrew-homebrew-core-Maintainer-Guide
If commits need to be amended use `brew pr-pull` instead. Let these commands - Homebrew/linuxbrew-core: https://docs.brew.sh/Homebrew-linuxbrew-core-Maintainer-Guide
auto-close issues whenever possible (it may take up to 5 minutes). If in doubt, - Homebrew/homebrew-cask: https://docs.brew.sh/Homebrew-homebrew-cask-Maintainer-Guide
check with e.g. Fork.app that you've not accidentally added merge commits.
If bottles are unnecessary, use GitHub's "Merge pull request" button in
"Squash and merge" mode for a single formula change.
- Still create your branches on your fork rather than in the main repository. - Still create your branches on your fork rather than in the main repository.
Note GitHub's UI will create edits and reverts on the main repository if you Note GitHub's UI will create edits and reverts on the main repository if you
make edits or click "Revert" on the Homebrew/brew repository rather than your make edits or click "Revert" on the Homebrew/brew repository rather than your
own fork. own fork.
- If still in doubt please ask for help and we'll help you out. - If still in doubt please ask for help and we'll help you out.
- Please read: - Please read:
- https://docs.brew.sh/Brew-Test-Bot-For-Core-Contributors
- https://docs.brew.sh/Maintainer-Guidelines - https://docs.brew.sh/Maintainer-Guidelines
- the team-specific guides linked above and in the maintainer guidelines
- anything else you haven't read on https://docs.brew.sh - anything else you haven't read on https://docs.brew.sh
How does that sound? How does that sound?