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

chore: fix typo & add spell check #713

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

spacewander
Copy link

No description provided.

@CLAassistant
Copy link

CLAassistant commented Nov 22, 2024

CLA assistant check
All committers have signed the CLA.

@AsterDY
Copy link
Collaborator

AsterDY commented Nov 25, 2024

Pls submit more as much as possible

@spacewander
Copy link
Author

@AsterDY
Copy link
Collaborator

AsterDY commented Nov 28, 2024

sure,you can add it

Signed-off-by: spacewander <[email protected]>
@spacewander spacewander changed the title chore: fix typo in api.go chore: fix typo & add spell check Dec 7, 2024
@spacewander
Copy link
Author

@AsterDY
Updated. Please take a look if you have free time.

@spacewander
Copy link
Author

It seems the self-hosted runner doesn't have pip installed. I will handle it later.

python3 <(curl -s https://bootstrap.pypa.io/pip/3.7/get-pip.py)
pip install codespell==2.3.0
# ignore test files, go project names, binary files via `--skip` and special var/regex via `--ignore-words`
git grep --cached -l '' | xargs codespell --skip 'fuzz/*,*_test.tmpl,testdata/*,*_test.go,go.mod,go.sum,*.gz' --ignore-words=.github/workflows/.ignore_words

Choose a reason for hiding this comment

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

I'm also a codespell fan and user

I would like to suggest you to create a .codespellrc file

This way codespell could be invoked locally with the same options that you are defining

The syntax is something close to this

[[codespell]] 
skip='fuzz/*,*_test.tmpl,testdata/*,*_test.go,go.mod,go.sum,*.gz' ignore-words=.github/workflows/.ignore_words

And here it could simplified

Suggested change
git grep --cached -l '' | xargs codespell --skip 'fuzz/*,*_test.tmpl,testdata/*,*_test.go,go.mod,go.sum,*.gz' --ignore-words=.github/workflows/.ignore_words
git grep --cached -l '' | xargs codespell

.github/workflows/lint.yml Outdated Show resolved Hide resolved
spacewander and others added 2 commits December 21, 2024 20:23
Signed-off-by: spacewander <[email protected]>
@spacewander
Copy link
Author

@AsterDY @ccoVeille
Updated.

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.

4 participants