-
Notifications
You must be signed in to change notification settings - Fork 475
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 codespell config (to ignore loved "poped") and github workflow to prevent future typos #755
Conversation
.github/workflows/codespell.yml
Outdated
|
||
on: | ||
push: | ||
branches: [devel] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's run on all branches.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
branches: [devel] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done locally
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't commit this because I would still need to do a rebase to include the change into the commit that introduced .github/workflows/codespell.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need - already done. I just thought first to do while on the phone, hence did suggestions, but then realized that need to get to laptop anyways.
.github/workflows/codespell.yml
Outdated
push: | ||
branches: [devel] | ||
pull_request: | ||
branches: [devel] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's run on all branches.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
branches: [devel] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done locally
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR. It looks good except in two places and even there the PR was perfect at the time it was created.
Seems like |
Ok, I can beg to differ that it is often great to discover what command actually did the change, but that's ok - I will later rewrite that commit and ping here |
I agree, but perhaps a better place would be in CONTRIBUTING.md and/or in error message that would be shown on Github actions logs in case spell check failed. But that's only if the command is not something arcane that very few people would be using. |
89f33a0
to
82bd6a9
Compare
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
82bd6a9
to
cf90ab2
Compare
Sure thing it is good to have clear instructions/documentation. But it is IMHO quite orthogonal to commit messages being descriptive, especially in case of use of some one-off tool, but also if it is some well known tool -- I guess I just like provenance ;-) Of cause in the case here of a single typo -- doesn't really matter much. But anyways -- I simplified commit message. force-pushed |
Thanks a lot! |
There were prior runs of codespell committed (e.g. 78f8cad ). But typos would keep appearing unless caught at their inception, which is what this PR proposes to accomplish.