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.

Sign up for GitHub

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

Jump to bottom

Add a CI for detecting typos #188

Closed
ccoVeille opened this issue Sep 1, 2024 · 4 comments · Fixed by #190
Closed

Add a CI for detecting typos #188

ccoVeille opened this issue Sep 1, 2024 · 4 comments · Fixed by #190

Comments

@ccoVeille
Copy link
Contributor

Following #187, may I suggest to set up a CI for catching obvious typos?

I did it on many repository, I can help.

I would suggest a linter that has almost no false positive
@EwenQuim
Copy link
Member

EwenQuim commented Sep 1, 2024

Ok, why not!

Can you add it in the Makefile too? Thanks!

@imransolanki imransolanki mentioned this issue Sep 2, 2024
Merged
@imransolanki
Copy link
Contributor

imransolanki commented Sep 2, 2024 •
edited
Loading

@EwenQuim @ccoVeille Can you please review and approve the PR here - #189?

@asahasrabuddhe
Copy link
Contributor

This one has been addressed with #189. This one can be closed!

@ccoVeille
Copy link
Contributor Author

Misspell is fine, I planned to add it too.

So thank you!

but unfortunately it is not enough for documenation in Markdown files.

Please let this issue open, I'll open a PR soon

ccoVeille added a commit to ccoveille-forks/go-fuego that referenced this issue Sep 4, 2024
@ccoVeille
ci: add a spellchecker to GitHub CI
eedbbb8 
This checker won't detect all typos, but will report the obvious ones.

It's a matter of balance. Too much typos, leads to false-positive.
false-positive leads to maintain a list of exception, quite a pain.

Fixes go-fuego#188
@ccoVeille ccoVeille mentioned this issue Sep 4, 2024
Merged
ccoVeille added a commit to ccoveille-forks/go-fuego that referenced this issue Sep 4, 2024
@ccoVeille
ci: add a spellchecker to GitHub CI
ae6975f 
This checker won't detect all typos, but will report the obvious ones.

It's a matter of balance. Too much typos, leads to false-positive.
false-positive leads to maintain a list of exception, quite a pain.

Fixes go-fuego#188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ci: add a spellchecker to GitHub CI ccoveille-forks/go-fuego
4 participants
@ccoVeille @imransolanki @asahasrabuddhe @EwenQuim