Skip to content

Proposal: Implement Vale linter to catch typos, grammar issues and inappropriate word use #148

@RCheesley

Description

@RCheesley

Hi folks,

While working on #145 I found numerous incidents of typos and grammar errors in the docs.

I'd like to suggest implementing the Vale linter, which would allow you to get real-time feedback within your IDE, but also could be implemented as a GitHub Action, preventing the merging of a PR until the issues are addressed and warning of any potential issues which could be discussed (for example using a word which might be culturally insensitive, where alternatives could be used).

The rules can be set to match your project's requirements as regards to style or you can use some of the available style plugins, such as Google's Style Guide for technical writing.

I will make a PR to suggest using Google's style guide which is quite a popular one, and Alex which helps to catch words and phrases which could be culturally insensitive. It can be tweaked to your own needs and could also of course be completely created from scratch rather than using an 'off the shelf' style if that's better for the project.

PR incoming :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions