diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 01b79c783f840..9f32a722cc97b 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -112,22 +112,28 @@ To make changes on a new branch and submit it for review, create a GitHub pull r 4. Make your changes. For formulae or casks, use `brew edit` or your favourite text editor, using the guidelines in the [Formula Cookbook](Formula-Cookbook.md) or [Cask Cookbook](Cask-Cookbook.md) for reference. * If there's a `bottle do` block in the formula, don't remove or change it; we'll update it when we merge your PR. -5. Test your changes by running the following, and ensure they all pass without issue. For changed formulae and casks, make sure you do the `brew audit` step after your changed formula/cask has been installed. +5. For changed formulae and casks, make sure you do the `brew lgtm` step after your changed formula/cask has been installed. For formulae: ```sh HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source brew test - brew audit --strict --online +brew lgtm ``` + For new formulae, use `--new` instead (which implies `--strict`, `--online` and additional new-formula eligibility checks): + + ```sh + HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source + brew lgtm + ``` For casks: ```sh HOMEBREW_NO_INSTALL_FROM_API=1 brew install --cask brew uninstall --cask - brew audit --strict --online --cask + brew lgtm ``` 6. [Make a separate commit](Formula-Cookbook.md#commit) for each changed formula with `git add` and `git commit`. Each formula's commits must be squashed.