Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 2.16 KB

Contributing to Homebrew

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

Ensure your commits follow the commit style guide.

Thanks for contributing!

How To Contribute

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

Getting Set Up To Contribute

  1. Fork the repository in GitHub with the Fork button

  2. If you have not already done so, add your GitHub fork as a remote for your homebrew-coatl-dev Tap:

    github_user='<my-github-username>'
cd "$(brew --repository)"/Library/Taps/coatl-dev/homebrew-coatl-dev
git remote add "${github_user}" "https://github.com/${github_user}/homebrew-coatl-dev"

  3. If you have already added your GitHub fork as a remote for your homebrew-cask Tap, ensure your fork is up-to-date

Then you will be able to add or update a formula.

Adding a Formula

With a bit of work, you can create a Formula for it. The document Adding A Formula will help you create, test, and submit a new Formula to us.

Updating a Formula

Notice an application that's out-of-date in homebrew-coatl-dev Formula? In most cases, it's very simple to update it. We have a command that will accept a new version number and take care of updating the Formula file and submitting a pull request to us.

If updating ignition, check if the same upgrade has been already submitted by searching the open pull requests for ignition.

Example for ignition (a.k.a. [email protected]):

brew bump-formula-pr --url <URL> --sha256 <SHA> --version 8.1.x ignition

Example for Ignition 7.9:

brew bump-formula-pr --url <URL> --sha256 <SHA> [email protected]