Contribute to the Vale at Red Hat project

Learn how to contribute to the Vale at Red Hat project. This guide covers the repository structure, contribution workflow, and how to extend Vale by adding new words to the spelling rule or creating custom style rules. Whether you’re fixing bugs, adding new rules, or improving documentation, this guide will help you get started.

Join us! ✨

Hello! We’re happy you’re thinking about joining our project. Every bit helps, whether you’re fixing a typographical error, suggesting an improvement, or just getting to know the community. Got questions or need help? Ask us in the Slack channel #vale-at-red-hat, in the CoreOS workspace.

There are many ways you can help:

• Make our docs better: Use Vale to help make our documentation clearer. Check out how to set Vale up here: Installing Vale CLI.

• Tell us what you think: Let us know if something doesn’t work right or if you have a great idea. Go here to share your thoughts: Report issues and request enhancements.

• Chat with us: Come talk to us on Slack in our chat room #vale-at-red-hat.

• Share your work: Do you want to contribute changes? Please share it with us by following this guide: Git forking workflow.

• Add your touch: Interested in adding rules or styles? Learn how here: Extending Styles.

Vale at Red Hat repository

The vale-at-red-hat repository has resources to validate language in documentation projects with Vale:

• Red Hat style for Vale in the .vale/styles/RedHat directory

• AsciiDoc style in the .vale/styles/AsciiDoc directory

• OpenShift AsciiDoc style in the .vale/styles/OpenShiftAsciiDoc directory

• Vale configuration files for usage in a local environment or by the GitHub Action.

• User guide

• Contributor guide

Additional resources

• vale-at-red-hat repository

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.

Note

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

Prerequisites

• Installing Vale CLI

• Understanding Vale output

• Defining a Vale onboarding strategy

• You forked and cloned the vale-at-red-hat repository using the Git forking workflow.

Procedure

1. Configure the rule in the styles folder: .vale/styles/<Style>/<StyleName>.yml.

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

3. 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.

4. Add, commit and push your changes.

5. Request a review or help in the Slack channel #vale-at-red-hat, in the CoreOS workspace.

Additional resources

• Vale documentation - Styles

• Sample PR