Skip to content

Prevent agents from adding misspellings to .cspell.yaml word list#26

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/update-linting-docs-and-cspell-comments
Mar 19, 2026
Merged

Prevent agents from adding misspellings to .cspell.yaml word list#26
Malcolmnixon merged 4 commits intomainfrom
copilot/update-linting-docs-and-cspell-comments

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 19, 2026

Agents have been bypassing spell-checking by adding misspelled words to .cspell.yaml, defeating its purpose. This adds explicit policy guardrails in both the config file and documentation.

.cspell.yaml

Adds a prominent IMPORTANT block at the top of the file:

  • Never add a word to silence a spell-check failure — fix the source instead
  • Only genuine, correctly-spelled technical terms qualify for the word list
  • Any addition requires a proposal (issue/PR) that is reviewed and approved before merging

docs/linting.md

  • Removes the open-ended suggestion to freely extend the word list as the project grows
  • Adds a Word list policy subsection documenting the same rules as the config comments

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update linting documentation and .cspell.yaml comments Prevent agents from adding misspellings to .cspell.yaml word list Mar 19, 2026
Copilot AI requested a review from Malcolmnixon March 19, 2026 15:49
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI requested a review from Malcolmnixon March 19, 2026 15:57
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 19, 2026 15:57
Copilot AI review requested due to automatic review settings March 19, 2026 15:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s spell-checking guidance to prevent bypassing cspell by adding misspellings to the .cspell.yaml word list, aligning linting documentation with a stricter word-list policy.

Changes:

  • Tightens .cspell.yaml header guidance to discourage adding misspellings to the word list.
  • Updates docs/linting.md to replace the “extend as the project grows” guidance with an explicit word-list policy section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
templates/lint/.cspell.yaml Adds policy-oriented comments above the cspell configuration/word list.
docs/linting.md Documents a stricter word-list policy and removes open-ended guidance about extending the list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@Malcolmnixon
Copy link
Copy Markdown
Contributor

@copilot apply changes based on the comments in this thread

…ded'

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants