-
Notifications
You must be signed in to change notification settings - Fork 83
Description
What would you like to be added/modified:
I've noticed several spelling errors and minor typos in the documentation and code comments throughout the repository. While none of them are critical, fixing them will improve the overall quality and readability of the project.
Like:
stARTT: Should be start
documenattionncan: Should be documentation can
abiother: Should be another
firts: Should be first
contributrbute: should be contribute any many more
Why is this needed:
This gives a more formal look to the repo and enhances Professionalism and Credibility ,Clarity and Readability and a better User Experience.
Solution:
I can manually do the changes but number is quite high especially in README.md or docs .
Investigate and propose a Continuous Integration (CI) process to automatically check for spelling errors in future contributions is a good idea I believe. This would help prevent similar issues from being introduced later.
What I propose:
I see the workflow main-doc.yaml which is indeed triggered only by documentation changes and is configured to skip other CI check . If I add a great Python module for this task like pyspelling. It is highly configurable and works well within a CI environment , It will make sure to run when any doc or md files changed.