diff --git a/docs/Acceptable-Formulae.md b/docs/Acceptable-Formulae.md index 015018ae82..0463225972 100644 --- a/docs/Acceptable-Formulae.md +++ b/docs/Acceptable-Formulae.md @@ -56,7 +56,7 @@ The software in question must: * be maintained (i.e. the last release wasn't ages ago, it works without patching on all Homebrew-supported OS versions and has no outstanding, unpatched security vulnerabilities) * be stable (e.g. not declared "unstable" or "beta" by upstream) -* be known +* be known (e.g. GitHub repositories should have >30 forks, >30 watchers and >75 stars) * be used * have a homepage diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 423d3bbc89..f05cf7578a 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -401,11 +401,11 @@ The established standard for Git commit messages is: * two (2) newlines, then * explain the commit thoroughly. -At Homebrew, we like to put the name of the formula up front like so: `foobar 7.3 (new formula)`. +At Homebrew, we require the name of the formula up front like so: `foobar 7.3 (new formula)`. This may seem crazy short, but you’ll find that forcing yourself to summarise the commit encourages you to be atomic and concise. If you can’t summarise it in 50 to 80 characters, you’re probably trying to commit two commits as one. For a more thorough explanation, please read Tim Pope’s excellent blog post, [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). -The preferred commit message format for simple version updates is `foobar 7.3` and for fixes is `foobar: fix flibble matrix.`. Please squash your commits into one with this message format, otherwise your PR will be replaced by our autosquash workflow. +The required commit message format for simple version updates is `foobar 7.3` and for fixes is `foobar: fix flibble matrix.`. Please squash your commits into one with this message format, otherwise your PR will be replaced by our autosquash workflow. Ensure you reference any relevant GitHub issue, e.g. `Closes #12345` in the commit message. Homebrew’s history is the first thing future contributors will look to when trying to understand the current state of formulae they’re interested in. diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index dedf38da2a..f39a322dce 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -113,8 +113,8 @@ To make changes on a new branch and submit it for review, create a GitHub pull r brew audit --strict --online ``` -6. [Make a separate commit](Formula-Cookbook.md#commit) for each changed formula with `git add` and `git commit`. - * Please note that our preferred commit message format for simple version updates is "` `", e.g. "`source-highlight 3.1.8`". +6. [Make a separate commit](Formula-Cookbook.md#commit) for each changed formula with `git add` and `git commit`. Each formula's commits must be squashed. + * Please note that our required commit message format for simple version updates is "` `", e.g. "`source-highlight 3.1.8`". 7. Upload your branch of new commits to your fork: ```sh