Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
54 lines (37 loc) 路 3.41 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) 路 3.41 KB
Raw

How To Contribute

馃憤馃帀 First off, thanks for taking the time to contribute! 馃帀馃憤

Getting Set Up To Contribute

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

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.

Adding a Cask

Notice an application that's not in Homebrew Cask yet? Make sure it's also not in 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).

AI/LLM usage

We allow you to create issues and pull requests with AI/LLM with the following requirements (see Responsible AI Usage for the principles behind them):

  • You must disclose in the initial issue or pull request that you used AI/LLM and what tool/model/etc. you used.
  • You must review all AI/LLM generated code, prose, etc. content before you ask anyone in Homebrew to review it for you.
  • You must not attribute a commit to AI/LLM as an author, co-author, committer or signatory, including through an Assisted-by, Co-developed-by or similar commit trailer.
  • You must answer all maintainer questions and pull request review comments yourself, without using AI/LLM.
  • Unless you are a maintainer, you may only have one AI-assisted/generated pull request open at a time.
  • If you reach the point where you feel unwilling or unable to do the above, please close your issue or pull request.