Contributing to Brewsci/bio

February 8, 2018 · View on GitHub

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

Report a bug

Submit a version upgrade for the foo formula

  • check if the same upgrade has been already submitted by searching the open pull requests for foo.
  • brew bump-formula-pr --strict foo with --url=... and --sha256=... or --tag=... and --revision=... arguments.

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 --build-from-source foo
  • brew audit --new-formula foo
  • git commit with message formatted foo 2.3.4 (new formula)
  • open a pull request and fix any failing tests

Contribute a fix to the foo formula

  • brew edit foo and make edits
  • leave the bottle as-is
  • brew uninstall --force foo, brew install --build-from-source foo, brew test foo, and brew audit --strict foo
  • git commit with message formatted foo: fix <insert details>
  • open a pull request and fix any failing tests

Thanks!

Creating a Formula

First see the Homebrew documentation and the Formula Cookbook.

Citation

Include a citation to the tool before the desc. For example:

  # cite Smith_2010: "https://doi.org/10.1234/56789"

The citation label is the first author's surname and year of publication separated by an underscore. Please use doi.org to look up the citation label for a DOI:

curl -LH "Accept: text/bibliography; style=bibtex" "https://doi.org/10.1234/56789"