Vale for prose checking #135
Merged
Conversation
This file contains 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
|
I've double-checked that we pick up |
stefaniuk
reviewed
Oct 6, 2023
There was a problem hiding this comment.
This is a good PR. Thanks @regularfry
Should we configure this check as a git hook as well? I.e. to add it to the scripts/config/pre-commit.yaml file.
stefaniuk
requested changes
Oct 13, 2023
This patch adds a `test-style` make target that runs the `vale` prose checker. It also fixes an annoyance where `vale` would complain about not being given any files, for the case where either nothing was staged, or nothing unstaged had been changed.
stefaniuk
approved these changes
Nov 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Vale is a tool for performing a certain set of style checks, which this PR introduces for markdown files only. Vale can scan code comments, but as an initial validation we should limit the scope.
WIP for the moment while I sort out github action integration.
Context
We want to be sure that our documentation is consistent and readable.
Type of changes
Checklist
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.