From 043fdb59faaf38f9748ea36706fd3a15ddc689ad Mon Sep 17 00:00:00 2001 From: Ed Page Date: Mon, 13 Mar 2023 15:05:30 -0500 Subject: [PATCH] docs(contrib): Note the pinned dict issue --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd2d871..31cac6a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,13 @@ to re-work some of it and the discouragement that goes along with that. ### Updating the Dictionary -`typos` dictionary is a mapping of typos to a list of possible corrections (see [Design](docs/design.md)). To add to the dictionary: +`typos` dictionary is a mapping of typos to a list of possible corrections (see [Design](docs/design.md)). + +If you aren't in a hurry, [we have a pinned +Issue](https://github.com/crate-ci/typos/issues) to collect dictionary changes +to be done in bulk in an attempt to lower the barrier for improving the dictionary. + +Otherwise, to add to the dictionary: 1. Add your typo to our data file `crates/typos-dict/assets/words.csv`