This repository the home for the Upbound implementation of Vale.

What's Vale

Vale is an open source command-line tool to provide English language linting. Vale enables spell checking, writing improvements and style guide enforcement in files across text and code.

Vale uses "Packages" to define the set of rules for writing to follow.

Upbound's use of Vale

Upbound uses the following Vale packages:

• alex - Catch insensitive, inconsiderate writing.
• proselint - to try and improve writing styles.
• Google - the Google style guide for their Developer Documentation.
• Microsoft - based on the Microsoft Writing Style Guide.
• write-good - Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
• GitLab - The GitLab style guide.

Warnings and errors

Upbound treats warnings and errors the same. All Vale tests must pass for approval.

Contributing and customizing

Upbound welcomes contributions and changes to the main branch.

Use these guidelines for contributions:

• Edit existing packages first. This includes removing duplicate rules (common with Google and Microsoft), adding acronyms.
• Add Upbound specific words to the Upbound Spelling file.
• Try to keep any modified lists in a case-insensitive alphabetical order.