Skip to content

Commit

Permalink
Update CONTRIBUTING.md (Homebrew#117132)
Browse files Browse the repository at this point in the history
  • Loading branch information
miccal authored Jan 9, 2022
1 parent e032270 commit 412fb64
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Notice an application that's out-of-date in Homebrew Cask? In most cases, it's v
brew bump-cask-pr --version <new_version> <outdated_cask>
```

You can also follow the steps in [Adding a Cask](doc/development/adding_a_cask.md) for more complicated changes.
You can also follow the steps in [Adding a Cask](https://docs.brew.sh/Adding-Software-to-Homebrew) for more complicated changes.


## Getting Set Up To Contribute
Expand All @@ -43,7 +43,7 @@ $ git remote add "${github_user}" "https://github.com/${github_user}/homebrew-ca

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

With a bit of work, you can create a Cask for it. The document [Adding A Cask](doc/development/adding_a_cask.md) will help you create, test, and submit a new Cask to us.
With a bit of work, you can create a Cask for it. The document [Adding A Cask](https://docs.brew.sh/Adding-Software-to-Homebrew) will help you create, test, and submit a new Cask to us.


## Style guide
Expand All @@ -54,7 +54,7 @@ Some style guidelines:
* There should not be any extraneous comments - the only comments that should be used are the ones explicitly defined in the [Cask Cookbook](https://docs.brew.sh/Cask-Cookbook).
* The stanza order and position of newlines is important to make things easier (See [Stanza order](https://docs.brew.sh/Cask-Cookbook#stanza-order)).
* Use string manipulations to improve the maintainability of your Cask (See [`version` methods](https://docs.brew.sh/Cask-Cookbook#version-methods)).
* Test your cask using `brew audit/style` (See [testing](doc/development/adding_a_cask.md#testing-your-new-cask)).
* Test your cask using `brew audit/style` (See [testing](https://docs.brew.sh/Adding-Software-to-Homebrew#testing-your-new-cask)).
* Make one Pull Request per Cask change.
* Do not squash commits after updating a Pull Request.
* Use descriptive commit messages - mention app name and version (ie. `Upgrade Transmission.app to v2.82`).

0 comments on commit 412fb64

Please sign in to comment.