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 codespell config (to ignore loved "poped") and github workflow to prevent future typos #755

Merged
merged 5 commits into from
Mar 8, 2024

Conversation

yarikoptic
Copy link
Contributor

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.


on:
push:
branches: [devel]
Copy link
Collaborator

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
branches: [devel]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done locally

Copy link
Collaborator

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

Copy link
Contributor Author

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.

push:
branches: [devel]
pull_request:
branches: [devel]
Copy link
Collaborator

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
branches: [devel]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done locally

Copy link
Collaborator

@p12tic p12tic left a 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.

@p12tic
Copy link
Collaborator

p12tic commented Mar 8, 2024

Seems like [[DATALAD RUNCMD] run codespell throughout fixing 1 new typo](https://github.com/containers/podman-compose/pull/755/commits/89f33a04a9decc207a7a66edbddd7f57cd047aa8) could have a cleaner commit message. Most people who will dig in git history don't care what exact tool was used when the change is a spelling fix :)

@yarikoptic
Copy link
Contributor Author

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

@p12tic
Copy link
Collaborator

p12tic commented Mar 8, 2024

great to discover what command actually did the change

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.

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>
@yarikoptic
Copy link
Contributor Author

great to discover what command actually did the change

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.

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

@p12tic
Copy link
Collaborator

p12tic commented Mar 8, 2024

Thanks a lot!

@p12tic p12tic merged commit d468f85 into containers:main Mar 8, 2024
4 checks passed
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