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

Improve Vale spellcheck #500

Merged
merged 4 commits into from
Jul 27, 2023
Merged

Improve Vale spellcheck #500

merged 4 commits into from
Jul 27, 2023

Conversation

plumbis
Copy link
Collaborator

@plumbis plumbis commented Jul 27, 2023

In #475 it was noticed that typos of CompositeResourceDefinition aren't flagged by Vale.

As described in Vale #527 the default spellcheck ignores words with multiple caps in the word, assuming it's covered by something else.

We don't have an easy way to check for any misspelling of a kind like CompositeResourceDefinition.

Good News:
This PR fixes it and makes the spell checker more sensitive and it catches any error like this (and some others we had previously missed)

Bad News
It makes the spell checker more sensitive. It not picks up errors with links in line breaks and a few other conditions described in the Contributor guide updates that are part of this PR. Going forward I expect a small uptick in the work we have to do in order to keep the spelling exceptions updated.

Resolves #490

Signed-off-by: Pete Lumbis [email protected]

@netlify
Copy link

netlify bot commented Jul 27, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit b67ce16
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/64c1c7eccedd8d0008e8a153
😎 Deploy Preview https://deploy-preview-500--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@jeanduplessis jeanduplessis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jeanduplessis jeanduplessis merged commit 0968bbe into crossplane:master Jul 27, 2023
7 checks passed
@plumbis plumbis deleted the vale-xrd branch March 26, 2024 15:48
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 this pull request may close these issues.

Vale doesn't catch CompositeResourceDefinintions as an error
2 participants