Adding initial vale configuration. On every pull request and every push to master, here's what it will currently check for:
Punctuation errors, like missing or extra spaces
Punctuation at the end of headings
Ellipses
Accidental repeated words
Date format (US)
Latin phrases, like "i.e." or "e.g."
Redundant phrases, like "application program"
Common cliche phrases
In the future, I'd like to add checks for:
Spelling: the rule exists, but it's too noisy because we have some files in French, and for those it marks every word as a spelling error. Excluding files from vale is possible but not straightforward, so it will take some time to set up.
Correct headings: I think this is possible, but haven't been able to get it work at the right scope yet (instead of checking every file, it would check every line).
For now, the output will be most useful for me as I'm editing. When I've fixed some of the errors that it's currently catching, it should be clean enough to be useful for contributors. Eventually, it's probably best if we have a way for contributors to run it locally first, and then this is a secondary check for both us and them to catch the low-hanging fruit.
Adding initial vale configuration. On every pull request and every push to master, here's what it will currently check for:
In the future, I'd like to add checks for:
For now, the output will be most useful for me as I'm editing. When I've fixed some of the errors that it's currently catching, it should be clean enough to be useful for contributors. Eventually, it's probably best if we have a way for contributors to run it locally first, and then this is a secondary check for both us and them to catch the low-hanging fruit.