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
Maintainer's checklist on accepting formula PR #6440
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Homebrew/homebrew-core Merge Checklist | ||
|
||
The following checklist is intended to help maintainers decide on | ||
whether to merge, request changes or close a PR. It also brings more | ||
transparency for contributors in addition to | ||
[Acceptable Formulae](Acceptable-Formulae.md) requirements. | ||
|
||
This is a guiding principle. As a maintainer, you can make a call to either | ||
request changes from a contributor or help them out based on their comfort and | ||
previous contributions. Remember, as a team we | ||
[Prioritise Maintainers Over Users](Maintainers-Avoiding-Burnout.md) to avoid | ||
burnout. | ||
|
||
This is a more practical checklist; it should be used after you get familiar with | ||
[Maintainer Guidelines](Maintainer-Guidelines.md). | ||
|
||
## Checklist | ||
|
||
Check for: | ||
|
||
- previously opened active PRs, as we would like to be fair to contributors who came first | ||
- patches/`inreplace` that have been applied to upstream and can be removed | ||
- comments in formula around `url`, as we do skip some versions (for example [vim](https://github.com/Homebrew/homebrew-core/blob/359dbb190bb3776c4d6a1f603a271dd8f186f077/Formula/vim.rb#L4) or [v8](https://github.com/Homebrew/homebrew-core/blob/359dbb190bb3776c4d6a1f603a271dd8f186f077/Formula/v8.rb#L4)) | ||
- vendored resources that need updates (for example [emscripten](https://github.com/Homebrew/homebrew-core/commit/57126ac765c3ac5201ce53bcdebf7a0e19071eba)) | ||
- vendored dependencies (for example [certbot](https://github.com/Homebrew/homebrew-core/pull/42966/files)) | ||
- stable/announced release | ||
- some teams use odd minor release number for tests and even for stable releases | ||
- other teams drop new version with minor release 0 but promote it to stable only after a few minor releases | ||
- if the software uses only hosted version control (such as GitHub, GitLab or Bitbucket), the release should be tagged and if upstream marks latest/pre-releases, PR must use latest | ||
- does changelog mention addition/removal of dependency and is it addressed in the PR | ||
- does formula depend on versioned formula (for example `python@2`, `go@1.10`, `erlang@17`) that can be upgraded | ||
- commits | ||
- contain one formula change per commit | ||
- ask author to squash | ||
- rebase during merge | ||
- version update follows preferred message format for simple version updates: `foobar 7.3` | ||
- other fixes format is `foobar: fix flibble matrix` | ||
- you can use `--bump` flag for `brew pull` in case the PR have a single commit but the wrong message | ||
- bottle block is not removed | ||
|
||
Suggested reply: | ||
igas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
Please keep bottle block in place, [@BrewTestBot](https://github.com/BrewTestBot) takes care of it. | ||
``` | ||
- is there a test block for other than checking version or printing help? Consider asking to add one | ||
- if CI failed | ||
- due to test block - paste relevant lines and add `test failure` label | ||
- due to build errors - paste relevant lines and add `build failure` label | ||
- due to other formulae needing revision bumps - suggest to use the following command: | ||
``` | ||
# in this example PR is for `libuv` formula and `urbit` needs revision bump | ||
brew bump-revision --message 'for libuv' urbit | ||
``` | ||
EricFromCanada marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- make sure it is one commit per revision bump | ||
- if CI is green and formula `bottle :unneeded` you can merge it through GitHub UI | ||
- if CI is green and bottles need to be pulled, use: `brew pull --bottle $PR_ID` | ||
- don't forget to thank the contributor | ||
- celebrate the first-time contributors | ||
- suggest to use `brew bump-formula-pr` next time if this was not the case |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this can be easily misinterpreted and we could add a line here on how to handle multiple commits like
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changed to: