homebrew-cask/.github/PULL_REQUEST_TEMPLATE.md

**Important:** *Do not tick a checkbox if you haven’t performed its action.* Honesty is indispensable for a smooth review process.

_In the following questions `<cask>` is the token of the cask you're submitting._

After making any changes to a cask, existing or new, verify:

- [ ] The submission is for [a stable version](https://docs.brew.sh/Acceptable-Casks#stable-versions) or [documented exception](https://docs.brew.sh/Acceptable-Casks#but-there-is-no-stable-version).
- [ ] `brew audit --cask --online <cask>` is error-free.
- [ ] `brew style --fix <cask>` reports no offenses.

Additionally, **if adding a new cask**:

- [ ] Named the cask according to the [token reference](https://docs.brew.sh/Cask-Cookbook#token-reference).
- [ ] Checked the cask was not [already refused](https://github.com/Homebrew/homebrew-cask/search?q=is%3Aclosed&type=pullrequests).
- [ ] Checked the cask is submitted to [the correct repo](https://docs.brew.sh/Acceptable-Casks#finding-a-home-for-your-cask).
- [ ] `brew audit --cask --new <cask>` worked successfully.
- [ ] `HOMEBREW_NO_INSTALL_FROM_API=1 brew install --cask <cask>` worked successfully.
- [ ] `brew uninstall --cask <cask>` worked successfully.

---
-												PULL_REQUEST_TEMPLATE.md: update with important note (#82432)


											
										
										
											2020-05-18 23:26:31 +08:00
+								**Important:** *Do not tick a checkbox if you haven’t performed its action.* Honesty is indispensable for a smooth review process.
-												added pull request template

											
										
										
											2016-03-31 21:44:49 +08:00
-												Fix PR template references (#106661)


											
										
										
											2021-06-01 23:34:57 +08:00
+								_In the following questions `<cask>` is the token of the cask you're submitting._
-												Clarify existing vs new tasks in PR template (#141789)

This tripped me up and I ended up skipping the style check when creating a new cask.
											
										
										
											2023-02-25 05:44:30 +08:00
+								After making any changes to a cask, existing or new, verify:
-												added pull request template

											
										
										
											2016-03-31 21:44:49 +08:00
-												Fix broken link for documented exception in PR template (#104174)

* Fix broken link for documented exception in PR template

* change PR template links to docs.brew.sh
											
										
										
											2021-04-22 10:13:17 +08:00
+								- [ ] The submission is for [a stable version](https://docs.brew.sh/Acceptable-Casks#stable-versions) or [documented exception](https://docs.brew.sh/Acceptable-Casks#but-there-is-no-stable-version).
-												Update PULL_REQUEST_TEMPLATE.md (#122636)

It is worth considering adding the `--online` flag to the requested `brew audit` run. It will help prevent PRs being opened that aren't using `brew bump` or `brew bump-cask-pr` that don't consider livecheck or other variables, and aligns the audit more closely with what will be run by CI.
											
										
										
											2022-04-28 20:11:28 +08:00
+								- [ ] `brew audit --cask --online <cask>` is error-free.
-												Fix PR template references (#106661)


											
										
										
											2021-06-01 23:34:57 +08:00
+								- [ ] `brew style --fix <cask>` reports no offenses.
-												added pull request template

											
										
										
											2016-03-31 21:44:49 +08:00
-												PULL_REQUEST_TEMPLATE.md: update with important note (#82432)


											
										
										
											2020-05-18 23:26:31 +08:00
+								Additionally, **if adding a new cask**:
-												added pull request template

											
										
										
											2016-03-31 21:44:49 +08:00
-												Doc: Change reference to docs.brew.sh (#105726)

* Fix link

Co-authored-by: Sean Molenaar <SMillerDev@users.noreply.github.com>

Co-authored-by: Sean Molenaar <SMillerDev@users.noreply.github.com>
											
										
										
											2021-05-14 16:48:48 +08:00
+								- [ ] Named the cask according to the [token reference](https://docs.brew.sh/Cask-Cookbook#token-reference).
-												PULL_REQUEST_TEMPLATE: link to closed pull requests
											
										
										
											2024-04-05 07:39:00 +08:00
+								- [ ] Checked the cask was not [already refused](https://github.com/Homebrew/homebrew-cask/search?q=is%3Aclosed&type=pullrequests).
-												Doc: Change reference to docs.brew.sh (#105726)

* Fix link

Co-authored-by: Sean Molenaar <SMillerDev@users.noreply.github.com>

Co-authored-by: Sean Molenaar <SMillerDev@users.noreply.github.com>
											
										
										
											2021-05-14 16:48:48 +08:00
+								- [ ] Checked the cask is submitted to [the correct repo](https://docs.brew.sh/Acceptable-Casks#finding-a-home-for-your-cask).
-												Replace undocumented flag in PR template

Flag `--new-cask` is not listed in manpage for `brew audit`, and from
implementation it's the same as `--new` and `--new-formula`.

For cask tap, `--cask --new` is better.

See
- https://docs.brew.sh/Manpage#audit-options-formulacask-
- https://github.com/Homebrew/brew/blob/4.1.23/Library/Homebrew/dev-cmd/audit.rb
											
										
										
											2023-12-05 23:24:12 +08:00
+								- [ ] `brew audit --cask --new <cask>` worked successfully.
-												Use HOMEBREW_NO_INSTALL_FROM_API=1 in PR template

											
										
										
											2024-01-21 18:57:37 +08:00
+								- [ ] `HOMEBREW_NO_INSTALL_FROM_API=1 brew install --cask <cask>` worked successfully.
-												Fix PR template references (#106661)


											
										
										
											2021-06-01 23:34:57 +08:00
+								- [ ] `brew uninstall --cask <cask>` worked successfully.
-												PULL_REQUEST_TEMPLATE: add line breaker for easier PR comment editing

Signed-off-by: Rui Chen <rui@chenrui.dev>

											
										
										
											2024-02-27 00:29:03 +08:00
 								---