b745546943
Remove duplication, link to the API documentation more often, tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s and `@adamv`'s significant past contributions to Homebrew, delete some outdated or unneeded documentation, add some missing `Formula` API. entries and simplify/improve `CONTRIBUTING.md`. Closes Homebrew/homebrew#46179. Closes Homebrew/homebrew#46618. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2.5 KiB
2.5 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:
brew edit foo, editurlandsha256/tag, leave thebottleas-is,brew install foo,git commitwith 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 $URLand make edits,brew install foo,brew audit --online --strict foo,git commitwith 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 fooand make edits, leave thebottleas-is,brew install foo,git commitwith 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!