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

docs(contrib): Update codegen steps

Browse source 
Fixes #531
This commit is contained in:
Ed Page 2022-08-13 09:36:55 -05:00
parent 4e59b27518
commit 7eb8873950
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -35,25 +35,25 @@ to re-work some of it and the discouragement that goes along with that.
Format: `typo,correction[,correction...]` Format: `typo,correction[,correction...]`
2. Verify your change 2. Code-gen the dictionary
Run Run
```bash ```console
cargo run --package typos-dict-verify -- --input crates/typos-dict/assets/words.csv --output crates/typos-dict/assets/words.csv $ SNAPSHOTS=overwrite cargo test --workspace
```
(we do development-time code-gen to speed up builds)
3. Verify your change
Run
```console
$ cargo test --workspace
``` ```
Auto-cleans up your change according to some rules we have like: 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/). - Don't prefer specific dialects in the dictionary, leaving those to [`varcon`](http://wordlist.aspell.net/varcon-readme/).
- Mixing up corrections and typos - Mixing up corrections and typos
- etc - etc
3. Code-gen the dictionary
Run
```bash
cargo run --package typos-dict-codegen -- --output crates/typos-dict/src/dict_codegen.rs
```
(we do development-time code-gen to speed up builds)
### Process ### Process
When you first post a PR, we request that the commit history get cleaned When you first post a PR, we request that the commit history get cleaned