ci: prose linting using Vale #14
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lasserich
approved these changes
Aug 26, 2025
| name: replace | ||
| swap: | ||
| are not: aren't | ||
| cannot: can't |
There was a problem hiding this comment.
Suggested change
| cannot: can't | |
| can not: can't |
| @@ -0,0 +1,30 @@ | |||
| extends: substitution | |||
| message: "Use '%s' instead of '%s'." | |||
| link: 'https://developers.google.com/style/contractions' | |||
There was a problem hiding this comment.
This one says to only contract "dismisses" with "not". I am fine with keeping the extra work tho!
| swap: | ||
| (?:alumna|alumnus): graduate | ||
| (?:alumnae|alumni): graduates | ||
| air(?:m[ae]n|wom[ae]n): pilot(s) |
There was a problem hiding this comment.
This is a thing? Haha never heard of before.
There was a problem hiding this comment.
Where does this list come from, do we maintain it?
| @@ -1,3 +1,3 @@ | |||
| # Managed Control Planes (MCPs) | |||
| # Managed control planes (MCPs) | |||
There was a problem hiding this comment.
This should remain "Managed Control Planes" imo.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds prose linting using Vale. The configuration and rules can be adjusted in the future when we have more experience with the tool. For now, it is configured to follow Google's developer documentation style guide.
All warnings have been resolved. There are just some suggestions that can be ignored for now.