Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linting for language structure/style #390

Open
GuySartorelli opened this issue Nov 1, 2023 · 0 comments
Open

Add linting for language structure/style #390

GuySartorelli opened this issue Nov 1, 2023 · 0 comments

Comments

@GuySartorelli
Copy link
Member

GuySartorelli commented Nov 1, 2023

Initial linting was added in #11 but excluded linting language style/structure.

There's a lot of tools, such as https://vale.sh/, which can help us lint our language structure.

Linting should ideally include:

  • catch spelling mistakes
  • catch common american-spellings that should be using the UK english
  • as much of our writing style guidelines as possible
  • anything else we think would be appropriate

NOTE

  • We need to decide if this should apply to pre-existing changelogs (or changelogs at all) or not.

PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant