From 693e92eb4c3079f2e8ef45e1a42ffb203033c1d3 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Thu, 25 Aug 2016 16:57:47 +0200 Subject: [PATCH] Sync PR template with main repo. --- .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ea5de4bc5..fba4dc49d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,24 +1,20 @@ -##### Instructions +### Instructions -- Look for and complete the section relevant to your submission. Delete the others, including these `Instructions`. -- `{{cask_file}}` represents the cask file you’re submitting/editing (if applicable). -- If there’s a checkbox you can’t complete for any reason, that’s OK. Just explain in detail why you weren’t able to do so. +Delete the parts of this template that are not relevant (including these `Instructions`) and fill out the rest. +If there’s a checkbox you can’t complete for any reason, that’s OK. Just explain in detail why you weren’t able to do so. +*Note:* `{{cask_file}}` represents the cask file you’re submitting/editing. -### Changes to a cask -#### Editing an existing cask -- [ ] Commit message includes cask’s name (and new version, if applicable). +### Checklist + +- [ ] The commit message includes the cask’s name and version. - [ ] `brew cask audit --download {{cask_file}}` is error-free. - [ ] `brew cask style --fix {{cask_file}}` left no offenses. -#### Adding a new cask +Additionally, when **adding a new cask**: -- [ ] Checked there aren’t open [pull requests](https://github.com/caskroom/homebrew-versions/pulls) for the same cask. -- [ ] Checked there aren’t closed [issues](https://github.com/caskroom/homebrew-versions/issues) where that cask was already refused. -- [ ] Checked the cask follows the requirements of [acceptable casks](https://github.com/caskroom/homebrew-versions#acceptable-casks). +- [ ] Checked there are no open [pull requests](https://github.com/caskroom/homebrew-versions/pulls) for the same cask. +- [ ] Checked there are no closed [issues](https://github.com/caskroom/homebrew-versions/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 cask’s name. -- [ ] `brew cask audit --download {{cask_file}}` is error-free. -- [ ] `brew cask style --fix {{cask_file}}` left no offenses. - [ ] `brew cask install {{cask_file}}` worked successfully. - [ ] `brew cask uninstall {{cask_file}}` worked successfully.