33 lines (23 loc) · 1.59 KB

Contributing to Homebrew

First time contributing to Homebrew? Read our Code of Conduct.

Report a bug

run brew update (twice)
run and read brew doctor
read the Troubleshooting Checklist
open an issue on the formula's repository

Submit a version upgrade for the `foo` formula

check if the same upgrade has been already submitted by searching the open pull requests for foo.
brew bump-formula-pr --strict foo with --url=... and --sha256=... or --tag=... and --revision=... arguments.

Add a new formula for `foo` version `2.3.4` from `$URL`

read the Formula Cookbook or: brew create $URL and make edits
brew install --build-from-source foo
brew audit --new-formula foo
git commit with message formatted foo 2.3.4 (new formula)
open a pull request and fix any failing tests

Contribute a fix to the `foo` formula

brew edit foo and make edits
leave the bottle as-is
brew uninstall --force foo, brew install --build-from-source foo, brew test foo, and brew audit --strict foo
git commit with message formatted foo: <insert details>
open a pull request and fix any failing tests

Thanks!