Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 2.53 KB
Raw

How To Contribute

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Updating a Cask

Notice an application that's out-of-date in Homebrew Cask? In most cases, it's very simple to update it. We have a command that will take care of updating the cask file and submitting a pull request to us:

brew bump --open-pr <outdated_cask>

You can also follow the steps in the documentation on adding a cask for more complicated changes.

Getting Set Up To Contribute

Follow the guide in How to Open a Homebrew Pull Request.

Adding a Cask

Notice an application that's not in Homebrew Cask yet? Make sure it's not yet in homebrew/cask-versions or homebrew/core (can be searched with brew search). Mac App Store apps can't be installed via Homebrew Cask, but check out mas for an alternative.

With a bit of work, you can create a cask for it. The documentation on adding a cask will help you create, test, and submit a new cask to us.

Style Guide

Some style guidelines:

  • All casks and code should be indented using two spaces (never tabs). When brew style contradicts this, style must be followed.
  • There should not be any extraneous comments - the only comments that should be used are the ones explicitly defined in the Cask Cookbook.
  • The stanza order and position of newlines is important to make things easier (see Stanza order).
  • Use string manipulations to improve the maintainability of your cask (see version methods).
  • Test your cask using brew audit and brew style (see the documentation on testing and auditing).
  • Make one pull request per cask change.
  • Do not squash commits after updating a pull request.
  • Use descriptive commit messages - mention cask name and version/change (ie. transmission 2.82, google-chrome: update zap).