Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading