Skip to content

Commit baab2c0

Browse files
committed
Add section about typos in the contributor guide
1 parent c69da4e commit baab2c0

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,14 @@ configure pre-commit to run before each commit:
8585
pre-commit install
8686
```
8787

88+
### Spell-checking
89+
Ferrite uses [typos] for spell checking. If you have that installed,
90+
you run it locally with by running `typos` from the top level directory.
91+
To fix mistakes automatically, run `typos -w`, but be careful as e.g. names
92+
and words from other languages might be incorrectly corrected (which is why
93+
it is not included as a [pre-commit] hook). Exceptions should be added to
94+
`.typos.toml`.
95+
8896
[documenter]: https://juliadocs.github.io/Documenter.jl/
8997
[first-contributions]: https://github.com/firstcontributions/first-contributions
9098
[gh-edit-files]: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository
@@ -101,3 +109,4 @@ pre-commit install
101109
[so-mre]: https://stackoverflow.com/help/minimal-reproducible-example
102110
[tim-doc]: https://youtu.be/ZpH1ry8qqfw
103111
[tim-git]: https://youtu.be/cquJ9kPkwR8
112+
[typos]: https://github.com/crate-ci/typos

0 commit comments

Comments
 (0)