Skip to content

Commit 4491eb4

Browse files
committed
Add typos notes to CONTIBUTING.md
1 parent 5c04851 commit 4491eb4

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,19 @@ Like formatting your code with `rustfmt`, running clippy regularly and before yo
9999
cargo clippy
100100
```
101101
102+
#### Finding typos with `typos-cli`
103+
104+
[typos](https://github.com/crate-ci/typos) is a tool to check for typos in any of the repos files that are not whitelisted inside of `typos.toml`. It runs as a [GitHub Action](https://github.com/crate-ci/typos/blob/master/docs/github-action.md) as part of our CI.
105+
106+
1. To install
107+
```
108+
cargo binstall -y typos
109+
```
110+
2. Running `typos`
111+
```
112+
typos
113+
```
114+
102115
### Change requirements
103116
104117
Please consider the following when making a change:

0 commit comments

Comments
 (0)