Spell checker CI for Markdown (and maybe other) files
About the project
- Contact: @rhatto
- Chat: #tor-dev on
irc.oftc.net
- Video room: to be defined.
Participants
- @rhatto (I'm proposing more than one project to the 2023 Hackweek, so I might end up participating in just one, depending on other people interest in participate)
- etc
Summary
This is a proposal to write a spell checking GitLab CI/CD job (or a bot) to look for typos in Markdown files (and maybe other types).
Project A - Writing
The first project in this proposal would be to actually write the spell checking routine.
Some existing solutions that can be evaluated and used, or being just a source of inspiration:
- R2Devops - codespell
- codespell-project/codespell: check code for common misspellings
- check-spelling/check-spelling: Spelling checker action to check spelling in repositories / pull requests / commits
- betrybe/code-spell-checker-action
- CSpell | A Spell Checker for Code!
- Documentation for Spelling - spell checker for CI!
It may also be important to find a way to reduce false positives.
Project B - Integrating
In this project, the spell checker would be integrated into the following projects:
- Onion MkDocs.
- Onion TeX Slim.
- Onion Reveal (if it actually exists).
- ... and also in some repositories using these things (like The Onion Plan)!
Project C - Documenting
This project is about documenting how to use the spell checker in a repository.
Skills
Some knowledge in the following technologies may be needed in order to participate:
- Git/GitLab CI.
- Markdown.
- Writing documentation.
- Basic scripting (Python, shell).
Edited by Silvio Rhatto