Extending the Spelling rule

Extending styles in the vale-at-red-hat repository

The vale-at-red-hat repository is an open source project maintained and developed by volunteers. If you want to contribute to the Vale at Red Hat project, feel free to open a PR.

If you use a custom Vale rule set in your Red Hat project, please consider adding it to the vale-at-red-hat repository.

Prerequisites

Installing Vale
Understanding Vale output
Defining a Vale onboarding strategy
You forked and cloned the vale-at-red-hat repository using the Git forking workflow.

Procedure

Configure the rule in the styles folder: .vale/styles/<Style>/<StyleName>.yml.
Configure the test fixtures in the fixtures folder: .vale/fixtures/<Style>/<StyleName>/testinvalid.adoc|testvalid.adoc

Run the vale command in the test fixtures folder to ensure that the rule triggers as you expect, for example:

$ vale .

Example output

 testinvalid.adoc
 2:1  error  Quoted ID value is not closed.  AsciiDoc.ClosedIdQuotes
 6:1  error  Quoted ID value is not closed.  AsciiDoc.ClosedIdQuotes

✖ 2 errors, 0 warnings and 0 suggestions in 2 files.

Add, commit, and push your changes.
Request a review or help in the Slack channel #vale-at-red-hat, in the CoreOS workspace.

Additional resources