mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00

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>
2.6 KiB
2.6 KiB
Contributing to Homebrew
First time contributing to Homebrew? Read our Code of Conduct.
To report a bug:
- run
brew update
(twice), run and readbrew doctor
, read the Troubleshooting Checklist, open an issue on the formula's repository.
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
. -
brew edit foo
, editurl
andsha256
/tag
, leave thebottle
as-is,brew install foo
,git commit
with commit subjectfoo 1.2.3
, open a pull request and fix any failing tests.
To add a new formula for foo
version 2.3.4
from $URL
:
- Read the Formula Cookbook or:
brew create $URL
and make edits,brew install foo
,brew audit --online --strict foo
,git commit
with message formattedfoo 2.3.4 (new formula)
, open a pull request and fix any failing tests.
To contribute a fix to the foo
formula:
brew edit foo
and make edits, leave thebottle
as-is,brew install foo
,git commit
with message formattedfoo: fix <insert details>.
, open a pull request and fix any failing tests.
To report a security vulnerability:
- Email security@brew.sh (a private mailing list) with detailed reproduction instructions using our PGP key.
Thanks!