aboutsummaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorJohn Manoogian III2015-04-07 09:45:37 -0700
committerMike McQuaid2015-04-07 19:00:36 +0100
commit656d5b8891a2c23eab563c5e983ccb8a30d85930 (patch)
tree6e10b599117ca753dfb426ba888878a4ebe773e7 /share
parentf6d36fd2259dba6eaadadc8784c18f008b05d9e6 (diff)
downloadhomebrew-656d5b8891a2c23eab563c5e983ccb8a30d85930.tar.bz2
How To Open a PR: add commit guidelines.
Closes #38439. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'share')
-rw-r--r--share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md2
1 files changed, 1 insertions, 1 deletions
diff --git a/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md b/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md
index 2c626d4ff..87fc95148 100644
--- a/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md
+++ b/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md
@@ -15,7 +15,7 @@ To make a new branch and submit it for review:
4. Make your changes to any Homebrew formula with `brew edit` (following all the requirements in the [Formula Cookbook](Formula-Cookbook.md)). Run `brew audit ANY_CHANGED_FORMULA`, `brew tests` and `brew install ANY_CHANGED_FORMULA && brew test ANY_CHANGED_FORMULA` and ensure all of these pass without issue. If there's a `bottle do` block in the formula: don't remove it; we'll update it when we pull it.
5. Make a separate commit for each changed formula with `git add` and `git commit`.
6. Upload your new commits to the branch to your fork with `git push --set-upstream YOUR_USERNAME YOUR_BRANCH_NAME`
-7. Go to https://github.com/Homebrew/homebrew and create a pull request to request review and merge of commits in your pushed branch. Make sure you explain why the change is needed and, if fixing a bug, how to reproduce the bug. Await feedback or a merge from Homebrew's maintainers.
+7. Go to https://github.com/Homebrew/homebrew and create a pull request to request review and merge of commits in your pushed branch. Make sure you explain why the change is needed and, if fixing a bug, how to reproduce the bug. Please note that the preferred commit message format for simple version updates is "FORMULA_NAME NEW_VERSION", e.g. "`source-highlight 3.1.8`". Await feedback or a merge from Homebrew's maintainers.
To respond well to feedback: