diff --git a/.cspell.yaml b/.cspell.yaml index f352a07..ec308bc 100644 --- a/.cspell.yaml +++ b/.cspell.yaml @@ -5,11 +5,14 @@ # - Maintain professional documentation and code quality # - Catch spelling errors before publication # - Support consistent technical terminology usage +# - Misspelled words should be fixed in the source +# - NEVER add a misspelled word to the 'words' list +# - PROPOSE only genuine technical terms/names as needed version: "0.2" language: en -# Project-specific technical terms and tool names (update as needed) +# Project-specific technical terms and tool names words: - Anson - Blockquotes diff --git a/AGENTS.md b/AGENTS.md index d67b9a8..b7e7c25 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -48,6 +48,16 @@ implementation demonstrating best practices for DEMA Consulting .NET libraries. - **`.editorconfig`** - Code style (file-scoped namespaces, 4-space indent, UTF-8, LF endings) - **`.cspell.yaml`, `.markdownlint-cli2.yaml`, `.yamllint.yaml`** - Linting configs +### Spell check word list policy + +**Never** add a word to the `.cspell.yaml` word list in order to silence a spell-checking failure. +Doing so defeats the purpose of spell-checking and reduces the quality of the repository. + +- If cspell flags a word that is **misspelled**, fix the spelling in the source file. +- If cspell flags a word that is a **genuine technical term** (tool name, project identifier, etc.) and is + spelled correctly, raise a **proposal** (e.g. comment in a pull request) explaining why the word + should be added. The proposal must be reviewed and approved before the word is added to the list. + ## Requirements - All requirements MUST be linked to tests diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9aa2b66..e70d90c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -180,12 +180,13 @@ All markdown files must follow these rules (enforced by markdownlint): ### Spell Checking -All files are spell-checked using cspell. Add project-specific terms to `.cspell.yaml`: +All files are spell-checked using cspell. **Never** add a word to the `.cspell.yaml` word list in order to silence a +spell-checking failure. Doing so defeats the purpose of spell-checking and reduces the quality of the repository. -```yaml -words: - - myterm -``` +- If cspell flags a word that is **misspelled**, fix the spelling in the source file. +- If cspell flags a word that is a **genuine technical term** (tool name, project identifier, etc.) and is spelled + correctly, raise a **proposal** (e.g. comment in a pull request) explaining why the word should be added. The + proposal must be reviewed and approved before the word is added to the list. ## Quality Checks