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 a job for Codespell in the CI to check spelling #46

Open
officialcjunior opened this issue May 10, 2021 · 0 comments
Open

Add a job for Codespell in the CI to check spelling #46

officialcjunior opened this issue May 10, 2021 · 0 comments
Labels
good first issue Good for newcomers

Comments

@officialcjunior
Copy link
Member

Codespell is a tool for fix spelling mistakes in the source code. This can be added in the CI
to check for spelling mistakes in the pull requests.

Please note that you might need to ignore some legitimate words while running it. A rough
sketch of the command would look something like this:
$ codespell --skip *.png --ignore-words-list Gameboy,GameBoy,te,fo,ND,ptd

Link: https://github.com/codespell-project/codespell/
Another place on the web where Codespell is used in the CI: https://github.com/yuxans/haproxy-2.2/blob/5f3eb59aff48fb559f68cbedade1204f9c0a82ed/.github/workflows/codespell.yml

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

No branches or pull requests

1 participant