brew/CONTRIBUTING.md
Mike McQuaid b745546943 Overhaul, simplify and cleanup documentation.
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>
2015-12-07 13:37:49 +00:00

2.5 KiB

Contributing to Homebrew

First time contributing to Homebrew? Read our Code of Conduct.

To report a bug:

Submit a 1.2.3 version upgrade for the foo formula:

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 formatted foo 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 the bottle as-is, brew install foo, git commit with message formatted foo: fix <insert details>., open a pull request and fix any failing tests.

To report a security vulnerability:

Thanks!