CONTRIBUTING.md

Contributing to Linuxbrew

Linuxbrew is a fork of Homebrew. Homebrew is merged into Linuxbrew roughly once per week. To contribute a new formula or a new version of an existing formula, please submit your pull request to Homebrew rather than to Linuxbrew. Patches to fix issues that you have reproduced on both Linuxbrew and Homebrew should be sent to Homebrew. Please send your pull request to Linuxbrew if you are in doubt.

Patches to fix issues particular to Linux should not affect the behaviour of the formula on Mac. Use if OS.mac? and if OS.linux? as necessary to preserve the existing behaviour on Mac.

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 --strict 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 --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: fix <insert details>
• open a pull request and fix any failing tests

Thanks!