brew/CONTRIBUTING.md
James Elliott 2534884b64 CONTRIBUTING: how to check for existing PRs.
To avoid extra work on the part of contributors and maintainers, this
adds a step to the explanation of how to contribute a fix to a formula,
showing how to check if someone else has already done so, even if it
has not yet finished being tested, reviewed, and released.

Closes Homebrew/homebrew#48879.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-11 20:48:34 +00:00

2.6 KiB

Contributing to Homebrew

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

To report a bug:

Submit a 1.2.3 version upgrade for the foo formula:

To 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.

To contribute a fix to the foo formula:

  • brew edit foo and make edits, leave the bottle as-is, brew install foo, git commit with message formatted foo: fix <insert details>., open a pull request and fix any failing tests.

To report a security vulnerability:

Thanks!