actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-28 20:11:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(contrib): Fix list indentation

Browse source
This commit is contained in:
Martin Fischer 2023-08-11 13:25:56 +02:00
parent 967d6d751e
commit 2f6b2d065e
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
CONTRIBUTING.md
View file

@ -39,27 +39,27 @@ Otherwise, to add to the dictionary:
1. Add your typo to our data file `crates/typos-dict/assets/words.csv`
Format: `typo,correction[,correction...]`
Format: `typo,correction[,correction...]`
2. Code-gen the dictionary
With `cargo` and `rustfmt` installed, run
```console
$ SNAPSHOTS=overwrite cargo test --workspace
```
(we do development-time code-gen to speed up builds)
Auto-cleans up your change according to some rules we have like:
- Don't prefer specific dialects in the dictionary, leaving those to [`varcon`](http://wordlist.aspell.net/varcon-readme/).
- Mixing up corrections and typos
- etc
With `cargo` and `rustfmt` installed, run
```console
$ SNAPSHOTS=overwrite cargo test --workspace
```
(we do development-time code-gen to speed up builds)
Auto-cleans up your change according to some rules we have like:
- Don't prefer specific dialects in the dictionary, leaving those to [`varcon`](http://wordlist.aspell.net/varcon-readme/).
- Mixing up corrections and typos
- etc
3. Verify your change
Run
```console
$ cargo test --workspace
```
Run
```console
$ cargo test --workspace
```
### Process