brew/CONTRIBUTING.md

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 1.2.3 version upgrade for the foo formula

• check if the same upgrade has been already submitted by searching the open pull requests for foo.
• brew edit foo
• edit url and sha256/tag, leave the bottle as-is
• brew install foo
• run brew audit foo and fix any issues
• git commit with commit subject foo 1.2.3
• open a pull request and fix any failing tests

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 foo
• brew audit --online --strict 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 install foo, brew test foo, and brew audit foo
• git commit with message formatted foo: fix <insert details>
• open a pull request and fix any failing tests

Report a security vulnerability

• Email security@brew.sh (a private mailing list) with detailed reproduction instructions using our PGP key

Thanks!