Luke Boswell (Mar 14 2023 at 08:46): Luke Boswell (Mar 14 2023 at 08:46):I've got fat fingers... so I usually leave tyops everywhere. Just had CI break on a typo and learnt about the spellchecker.
I'm thinking of adding something to CONTRIBUTING.md so future contributors can check thier PRs before pushing.
Would this be a good instruction to add? How about this?
## Spellchecking
Running `typos` from the root `/roc` directory will check the workspace. Note the configuration in `typos.toml`.
Maybe also include cargo install typos-cli --version 1.0.11 as install instructions.
Anton (Mar 14 2023 at 09:18):Maybe also include
cargo install typos-cli --version 1.0.11as install instructions.
This way of installing may not work well with nix, you can add typos to the flake.nix file but it will be a newer version so you'll probably also have to correct some typos that it now can detect.
Brendan Hansknecht (Mar 14 2023 at 14:28):We could consider adding some of these fast things as git pre commit checks. Format of files and typos.
Luke Boswell (Mar 14 2023 at 19:15):I'm not sure how to do pre-commit hooks. Or is that just a text explanation we having in CONTRIBUTING.md to ask before people commit?
Brendan Hansknecht (Mar 14 2023 at 19:43):Pre commit hooks are commands that are run by git locally before a commit is be made.
Last updated: Jul 06 2025 at 12:14 UTC