aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Elliott2016-02-05 10:30:29 -0600
committerMike McQuaid2016-02-11 20:48:34 +0000
commit2534884b64129ef710de56c673405264103aef24 (patch)
treece185ce4adcdb6eec1844d41b0ebde2ade84f101
parentb06c6c74f9beb5eec1f1eecfd116fac5eae444f8 (diff)
downloadbrew-2534884b64129ef710de56c673405264103aef24.tar.bz2
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>
-rw-r--r--CONTRIBUTING.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 05e51dcf1..347cec23d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,6 +7,8 @@ To report a bug:
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.
To add a new formula for `foo` version `2.3.4` from `$URL`: