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

Document and enforce spelling policy #173

Merged
merged 2 commits into from
Jan 12, 2024
Merged

Conversation

afrittoli
Copy link
Contributor

Changes

Define spelling for docs and spec as en_US.
Add a CI job to enforce that and fix a couple of inconsistent spellings.

A custom dictionary is maintained at .spellcheck-en-custom.txt

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Define spelling for docs and spec as en_US.
Add a CI job to enforce that and fix a couple of inconsistent spellings.

A custom dictionary is maintained at .spellcheck-en-custom.txt

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
Copy link
Contributor

@e-backmark-ericsson e-backmark-ericsson left a comment

Choose a reason for hiding this comment

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

This PR looks good to me, except for many of the "words" in the custom wordlist

.spellcheck-en-custom.txt Show resolved Hide resolved
.spellcheck-en-custom.txt Outdated Show resolved Hide resolved
.spellcheck.yml Outdated Show resolved Hide resolved
@afrittoli afrittoli force-pushed the spelling branch 3 times, most recently from 7286a6c to eba3181 Compare January 12, 2024 14:30
Split spelling check of json and markdown files.

For markdown add a context filter to ignore code blocks (inline and multiline).
Enable url and camel case modes.

Change the action to a different one, based on the same technology
(pyspelling + aspell) as the current one does not support the came case
mode.

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
@afrittoli afrittoli merged commit e66556b into cdevents:main Jan 12, 2024
4 checks passed
@afrittoli afrittoli added this to the v0.4 milestone Apr 2, 2024
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.

2 participants