homebrew-cask/.github/PULL_REQUEST_TEMPLATE.md

24 lines
1.6 KiB
Markdown
Raw Normal View History

<!-- If theres a checkbox you cant complete for any reason, that's okay, just explain in detail why you werent able to do so. -->
2016-03-31 21:44:49 +08:00
After making all changes to the cask:
2016-03-31 21:44:49 +08:00
- [ ] `brew cask audit --download --appcast --token-conflicts {{cask_file}}` is error-free.
- [ ] `brew cask style --fix {{cask_file}}` reports no offenses.
- [ ] The commit message includes the casks name and version.
- [ ] The submission is for [a stable version](https://github.com/Homebrew/homebrew-cask/blob/master/doc/development/adding_a_cask.md#finding-a-home-for-your-cask) or [documented exception](https://github.com/Homebrew/homebrew-cask/blob/master/doc/development/adding_a_cask.md#but-there-is-no-stable-version).
2016-03-31 21:44:49 +08:00
Additionally, if **adding a new cask**:
2016-03-31 21:44:49 +08:00
- [ ] Named the cask according to the [token reference].
2016-03-31 21:44:49 +08:00
- [ ] `brew cask install {{cask_file}}` worked successfully.
- [ ] `brew cask uninstall {{cask_file}}` worked successfully.
- [ ] Checked there are no [open pull requests] for the same cask.
- [ ] Checked the cask was not [already refused].
- [ ] Checked the cask is submitted to [the correct repo].
2018-06-17 19:32:49 +08:00
[token reference]: https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md
[open pull requests]: https://github.com/Homebrew/homebrew-cask/pulls
[already refused]: https://github.com/Homebrew/homebrew-cask/search?q=is%3Aclosed&type=Issues
2018-06-17 19:32:49 +08:00
[the correct repo]: https://github.com/Homebrew/homebrew-cask/blob/master/doc/development/adding_a_cask.md#finding-a-home-for-your-cask
[version-checksum]: https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/sha256.md#updating-the-sha256