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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup codespell to avoid more typos #4555

Open
RayBB opened this issue Mar 28, 2024 · 6 comments 路 May be fixed by #4562
Open

setup codespell to avoid more typos #4555

RayBB opened this issue Mar 28, 2024 · 6 comments 路 May be fixed by #4562
Assignees

Comments

@RayBB
Copy link

RayBB commented Mar 28, 2024

There are currently tons of typos in this project. Someone should fix them.
Then setup codespell spell to check for them each time there is a pr 馃憤

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

image
@RayBB RayBB changed the title setup codespell setup codespell to avoid more typos Mar 28, 2024
@aroramrinaal
Copy link

I'd like to help out with fixing the typos in the project. I'll also set up Codespell Spell to catch them in future pull requests. I don't know Codespell yet, but I'm eager to learn on the go.

Could you please assign this issue to me?

@RayBB
Copy link
Author

RayBB commented Apr 4, 2024

@aroramrinaal you are assigned now.

@aroramrinaal
Copy link

@RayBB I was thinking of integrating codespell into the project by adding a script to run codespell checks, configuring it to scan for spelling mistakes, and setting it up to automatically execute within the CI/CD pipeline on each pull request.

Am I in the right direction?

@aroramrinaal aroramrinaal linked a pull request Apr 5, 2024 that will close this issue
@RayBB
Copy link
Author

RayBB commented Apr 5, 2024

@aroramrinaal
I'm not a maintainer of this project but that sounds about right to me. You probably will need a separate PR first to fix all of the typos that you can. Then you will need to add documentation for how to add exceptions for code spell when a word is spelt right but they think it's wrong (usually technical names).

@tomkoevoets
Copy link

hey there,

I'm a first year student in it and need to make a small bigger contribution to an open source project.
is there anybody that can help me on my way with this since its my first time and I'm reasonably unexperienced in programming.

thanks in advance,

Tom

@RayBB
Copy link
Author

RayBB commented May 9, 2024

@tomkoevoets there is already a PR open for this change so you'll have to find another issue 馃憤
#4562

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

Successfully merging a pull request may close this issue.

4 participants