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 support (config, workflow to detect/not fix) and make it fix few typos #701

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

yarikoptic
Copy link

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

@tripu tripu self-requested a review September 20, 2024 08:26
@tripu tripu self-assigned this Sep 20, 2024
@tripu tripu added the feature label Sep 20, 2024
@tripu
Copy link
Collaborator

tripu commented Sep 20, 2024

Thank you, it looks like a valuable contribution.

Unfortunately, the project has been in minimum maintenance mode for a while, and we're not even using GH Actions atm.

@tripu
Copy link
Collaborator

tripu commented Sep 20, 2024

How can I verify that this would be working OK when merged?

Shouldn't I see some successful runs of the GH Action pipeline here?

@yarikoptic
Copy link
Author

How can I verify that this would be working OK when merged?

locally -- just run codespell and see if it says anything

on CI -- submit a PR with a typo

Shouldn't I see some successful runs of the GH Action pipeline here?

hm, indeed it should have but it seems that https://github.com/gnab/remark/actions is "blank" as this is the first workflow added here. May be they also disabled in settings (but then why do I see that tab?). Overall, sorry -- don't have complete answer. Usually repos have at least some workflow and this is I think first case out of hundreds ;-)

FWIW - you could merge and see if it emerges among actions. I do not think there should be harm.

Or you could add in another PR some other action you like to just "kick start" github actions and then we could get back to this PR

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

Successfully merging this pull request may close these issues.

2 participants