admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #16789 from Homebrew/update-formulae-docs

Browse Source
This commit is contained in:
Patrick Linnane 2024-03-01 16:28:29 -08:00 committed by GitHub
commit 0a3549b7f2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Acceptable-Formulae.md
View File

@ -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 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 stable (e.g. not declared "unstable" or "beta" by upstream)
* be known * be known (e.g. GitHub repositories should have >=30 forks, >=30 watchers or >=75 stars)
* be used * be used
* have a homepage * have a homepage

4
docs/Formula-Cookbook.md
View File

@ -401,11 +401,11 @@ The established standard for Git commit messages is:
* two (2) newlines, then * two (2) newlines, then
* explain the commit thoroughly. * 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). 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. 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.

4
docs/How-To-Open-a-Homebrew-Pull-Request.md
View File

@ -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 <CHANGED_FORMULA|CHANGED_CASK> brew audit --strict --online <CHANGED_FORMULA|CHANGED_CASK>
``` ```
6. [Make a separate commit](Formula-Cookbook.md#commit) for each changed formula with `git add` and `git commit`. 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 preferred commit message format for simple version updates is "`<FORMULA_NAME> <NEW_VERSION>`", e.g. "`source-highlight 3.1.8`". * Please note that our required commit message format for simple version updates is "`<FORMULA_NAME> <NEW_VERSION>`", e.g. "`source-highlight 3.1.8`".
7. Upload your branch of new commits to your fork: 7. Upload your branch of new commits to your fork:
```sh ```sh