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>
This commit is contained in:
James Elliott 2016-02-05 10:30:29 -06:00 committed by Mike McQuaid
parent b06c6c74f9
commit 2534884b64

View File

@ -7,6 +7,8 @@ To report a bug:
Submit a `1.2.3` version upgrade for the `foo` formula: 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`](https://github.com/Homebrew/homebrew/pulls?utf8=✓&q=is%3Apr+is%3Aopen+foo).
- `brew edit foo`, edit [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) and [`sha256`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#sha256%3D-class_method)/[`tag`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method), leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is, `brew install foo`, `git commit` with commit subject `foo 1.2.3`, [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests. - `brew edit foo`, edit [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) and [`sha256`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#sha256%3D-class_method)/[`tag`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method), leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is, `brew install foo`, `git commit` with commit subject `foo 1.2.3`, [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests.
To add a new formula for `foo` version `2.3.4` from `$URL`: To add a new formula for `foo` version `2.3.4` from `$URL`: