From 7eb88739501dcce6eaca5089910a94151a91f96b Mon Sep 17 00:00:00 2001 From: Ed Page Date: Sat, 13 Aug 2022 09:36:55 -0500 Subject: [PATCH] docs(contrib): Update codegen steps Fixes #531 --- CONTRIBUTING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46dc6de..27fc921 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,25 +35,25 @@ to re-work some of it and the discouragement that goes along with that. Format: `typo,correction[,correction...]` -2. Verify your change +2. Code-gen the dictionary Run -```bash -cargo run --package typos-dict-verify -- --input crates/typos-dict/assets/words.csv --output crates/typos-dict/assets/words.csv +```console +$ 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: - 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. 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 When you first post a PR, we request that the commit history get cleaned