Added Codespell workflow

[Mohitkumar6122]

Fixes for #140. Added Codespell workflow to automate the identification of common misspellings in text files.

[Mohitkumar6122]

@laike9m, I have added the Codespell workflow as it checks the misspelt words in the source code and also allows the skipping of files during the check. Let me know if you want another workflow or does this one seems to work fine?

[laike9m]

Have you tried run it and see if it works?

[Mohitkumar6122]

@laike9m, I've tried it on my test branch and it works fine!

[Mohitkumar6122]

Also @laike9m, I'm trying to add typos to this project, but this performs a check on the whole repository instead of making the spell check on the PR( commits made by the contributor). But typos is great if we run in on a time interval as it automatically lists out the corrections needed in the project(like typos in repo). Also, we can run it locally and make the corrections listed out by the typos. So what are your thoughts on it?

[Mohitkumar6122]

Typos will give output like this

[laike9m]

Thanks for the change! May I ask what's the difference between Codespell and typos? My understanding is that typos can be used offline, and when running as GitHub Actions, they're pretty much the same?

[Mohitkumar6122]

@laike9m Here is the Comparison chart for typos with other spell checkers!

Also, Codespell takes more time to check the repo but is best for the small repos.

[Mohitkumar6122]

@laike9m, what are your suggestions, if we can add typos or codespell works fine?

[laike9m]

Let's add both, no harm to do that and we'll see how it goes.

[Mohitkumar6122]

@laike9m, Any suggestions from your side?

[laike9m]

Does typos require us to put a _typos.toml at the root directory? I'm really against putting more files on the root directory. Is it possible to move the settings into .github/workflows/typos.yml? If we cannot, then I would say don't add it.

[laike9m]

Btw, you can request review so I know. It's better than leaving a comment. Just a suggestion, not a big deal.

[Mohitkumar6122]

Btw, you can request a review so I know. It's better than leaving a comment. Just a suggestion, not a big deal.

I know @laike9m, but Pull request authors can't request reviews unless they are either a repository owner or collaborator with write access to the repository.

[Mohitkumar6122]

Does typos require us to put a _typos.toml at the root directory? I'm really against putting more files on the root directory. Is it possible to move the settings into .github/workflows/typos.yml? If we cannot, then I would say don't add it.

Surely @laike9m, I'll search for possible solutions for this problem!

[Mohitkumar6122]

@laike9m, I've searched up for the solutions and also talked to the creator of typos and he said this to me : "At the moment, that is explicitly out of scope to control certain behaviour outside of the config file

• That's a can of worms that can bloat the CLI / Action / Pre-commit
• We want consistent behaviour between different people and with CI.'

[laike9m]

ok, so that means "NO". Let's remove typos, then I'll LGTM. Thanks for looking into this!

[Mohitkumar6122]

Thanks, @laike9m, for this opportunity!

[laike9m]

You're welcome. There are many issues up for grab. Let me know if you're interested in taking any of them.