brew/docs/vale-styles/Homebrew/Terms.yml

---
extends: substitution
message: Use '%s' instead of '%s'.
link: "https://github.com/Homebrew/brew/blob/HEAD/docs/Prose-Style-Guidelines.md#terminology-words-and-word-styling"
level: error
scope: $paragraph
swap:
  Pull Request: pull request
  repo: repository
  Rubocop: RuboCop
Add Vale linting for our docs - I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations). 2019-12-09 18:42:14 +00:00			`---`
			`extends: substitution`
			`message: Use '%s' instead of '%s'.`
vale-styles: Upgrade all checks to "error" level - I added these all the way back in December 2019 in #6826, but only today realised that things have been failing unnoticeably because "warning" level exits with status code 0, so doesn't fail CI. - Upgrading to "error" level will enable us to see the style errors in our docs and fix them faster. - My editor also auto-formatted the YAML to have double quotes instead of single. 2020-10-17 21:47:58 +01:00			`link: "https://github.com/Homebrew/brew/blob/HEAD/docs/Prose-Style-Guidelines.md#terminology-words-and-word-styling"`
Add Vale linting for our docs - I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations). 2019-12-09 18:42:14 +00:00			`level: error`
Scope the Vale "terms" substitution lint to paragraphs only - This clears up the final four title-case "Pull Request" in titles, which are correct. 2019-12-11 22:28:00 +00:00			`scope: $paragraph`
Add Vale linting for our docs - I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations). 2019-12-09 18:42:14 +00:00			`swap:`
			`Pull Request: pull request`
			`repo: repository`
			`Rubocop: RuboCop`