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

Vale linter exceptions #1213

Closed
boardfish opened this issue Dec 17, 2021 · 3 comments · Fixed by #1289
Closed

Vale linter exceptions #1213

boardfish opened this issue Dec 17, 2021 · 3 comments · Fixed by #1289

Comments

@boardfish
Copy link
Collaborator

boardfish commented Dec 17, 2021

Noticed that in CONTRIBUTING.md, this phrase appears:

  1. Add an entry to the top of docs/CHANGELOG.md for your changes, no matter how small they're. We want to recognise your contribution!

Was pretty amusing to see, but it might also be a touch confusing for folks whose first language isn't English. Is there a way to add an exception to Vale for this and any other instances where Vale may have mistakenly enforced the wrong syntax?

It might also just be easier to change the phrasing to:

  1. Add an entry to the top of docs/CHANGELOG.md for your changes. No matter how small they may be, we want to recognise your contribution!
@Spone
Copy link
Collaborator

Spone commented Feb 14, 2022

In case we want to update the rule, we can use a regex with a negative lookahead, to ensure the matching they are is not at the end of a sentence.

- they are: they're
+ 'they are(?!\.)': they're

EDIT: we could also open a PR here

@boardfish
Copy link
Collaborator Author

I can do so - I trust regex is supported in keys?

@boardfish
Copy link
Collaborator Author

Made the change to the rule upstream. I'll reflect it within this repo too.

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

Successfully merging a pull request may close this issue.

2 participants