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

ci: Replace woke with codespell #267

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ci: Replace woke with codespell #267

wants to merge 1 commit into from

Conversation

spetrosi
Copy link
Contributor

@spetrosi spetrosi commented Jan 24, 2025

woke has been left with Noriko's and all other PRs not being reviewed for years,
hence we have been using our fork.

This PR replaces woke with codespell to detect non-inclusive language and check spelling

Codespell provides a built-in dictionary with recommended non-inclusive terms:
https://github.com/codespell-project/codespell/blob/main/codespell_lib/data/dictionary_usage.txt

Codespell supports using custom dictionaries so we can add to the list if we want.

ignore-multiline-regex in the .codespellrc config allows for disabling
codespell for a block of lines:

# codespell:ignore-begin
... codespell will not look at this text.
# codespell:ignore-end

You can ignore words inline by adding a comment like # codespell:ignore word.

You can ignore files and directories, and words by adding them to config file
.codespellrc.

For more information about inclusive naming initiative, see
https://inclusivenaming.org/about/

@spetrosi spetrosi self-assigned this Jan 24, 2025
README.md Outdated Show resolved Hide resolved
@spetrosi spetrosi marked this pull request as draft February 4, 2025 17:50
@spetrosi spetrosi force-pushed the codespell-init branch 3 times, most recently from ddad511 to 61a0773 Compare February 6, 2025 14:00
@spetrosi spetrosi force-pushed the codespell-init branch 4 times, most recently from f73176f to 4f4de9e Compare February 7, 2025 14:17
woke has been left with Noriko's and all other PRs not being reviewed for years,
hence we have been using our fork.

This PR replaces woke with codespell to detect non-inclusive language and check spelling

Codespell provides a built-in dictionary with recommended non-inclusive terms:
https://github.com/codespell-project/codespell/blob/main/codespell_lib/data/dictionary_usage.txt

Codespell supports using custom dictionaries so we can add to the list if we want.

`ignore-multiline-regex` in the `.codespellrc` config allows for disabling
codespell for a block of lines:

```
# codespell:ignore-begin
... codespell will not look at this text.
# codespell:ignore-end
```
You can ignore words inline by adding a comment like `# codespell:ignore word`.

You can ignore files and directories, and words by adding them to config file
`.codespellrc`.

For more information about inclusive naming initiative, see
https://inclusivenaming.org/about/

Signed-off-by: Sergei Petrosian <[email protected]>
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