homebrew-cask/.github/PULL_REQUEST_TEMPLATE.md

28 lines
1.4 KiB
Markdown
Raw Normal View History

##### Instructions
2016-03-31 21:44:49 +08:00
- Look for and complete the section relevant to your submission. Delete the others, including these `Instructions`.
2016-04-14 08:29:39 +08:00
- `{{cask_file}}` represents the cask file youre submitting/editing (if applicable).
2016-03-31 21:44:49 +08:00
- If theres a checkbox you cant complete for any reason, thats OK. Just explain in detail why you werent able to do so.
### Changes to a cask
#### Editing an existing cask
- [ ] Commit message includes casks name (and new version, if applicable).
- [ ] `brew cask audit --download {{cask_file}}` is error-free.
2016-03-31 21:44:49 +08:00
- [ ] `brew cask style --fix {{cask_file}}` left no offenses.
#### Adding a new cask
2016-04-04 23:14:19 +08:00
- [ ] Checked there arent open [pull requests](https://github.com/caskroom/homebrew-cask/pulls) for the same cask.
2016-03-31 21:44:49 +08:00
- [ ] Checked there arent closed [issues](https://github.com/caskroom/homebrew-cask/issues) where that cask was already refused.
- [ ] When naming the cask, followed the [token reference](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md).
- [ ] Commit message includes casks name.
- [ ] `brew cask audit --download {{cask_file}}` is error-free.
2016-03-31 21:44:49 +08:00
- [ ] `brew cask style --fix {{cask_file}}` left no offenses.
- [ ] `brew cask install {{cask_file}}` worked successfully.
- [ ] `brew cask uninstall {{cask_file}}` worked successfully.
### Changes to the core
- [ ] Followed [hacking.md](https://github.com/caskroom/homebrew-cask/blob/master/doc/development/hacking.md).