Skip to content

Apply ContinuousCompliance PR #26: enforce cspell word list policy#63

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/apply-pull-26-changes
Mar 19, 2026
Merged

Apply ContinuousCompliance PR #26: enforce cspell word list policy#63
Malcolmnixon merged 4 commits intomainfrom
copilot/apply-pull-26-changes

Conversation

Copy link
Contributor

Copilot AI commented Mar 19, 2026

Description

Agents have been bypassing spell-checking by adding misspelled words to .cspell.yaml. This applies ContinuousCompliance#26 to add explicit guardrails in the config, contributing docs, and agent docs, matching the changes in TemplateDotNetLibrary#45.

.cspell.yaml

  • Adds policy comments to the PURPOSE block: never add misspelled words; only propose genuine technical terms
  • Removes "update as needed" from the word list comment

CONTRIBUTING.md

  • Replaces the open-ended "add project-specific terms" guidance with a formal word list policy:
    • Fix misspellings in source; never suppress them via the word list
    • Genuine technical terms require a proposal (e.g. comment in a pull request) reviewed and approved before merging

AGENTS.md

  • Adds a "Spell check word list policy" subsection under Key Files with the same guardrail content as CONTRIBUTING.md

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.TemplateDotNetTool --configuration Release --framework net10.0
    --no-build -- --validate
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Documentation-only change. No build or test steps affected.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Apply changes from pull request #26 Apply ContinuousCompliance PR #26: enforce cspell word list policy Mar 19, 2026
Copilot AI requested a review from Malcolmnixon March 19, 2026 17:03
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon
Copy link
Contributor

@copilot Actually let's have this PR match the changes in demaconsulting/TemplateDotNetLibrary#45

… add AGENTS.md spell check policy section

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 19, 2026

@copilot Actually let's have this PR match the changes in demaconsulting/TemplateDotNetLibrary#45

Done in 154563c. Updated CONTRIBUTING.md to match the paragraph format from Library PR #45, and added the "Spell check word list policy" subsection to AGENTS.md.

@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 19, 2026 17:24
Copilot AI review requested due to automatic review settings March 19, 2026 17:24
Copilot AI requested a review from Malcolmnixon March 19, 2026 17:24
Copy link
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

This PR tightens repository guidance to prevent bypassing spell-checking by adding misspellings to the cspell word list, aligning documentation and agent instructions with the ContinuousCompliance policy.

Changes:

  • Updates CONTRIBUTING.md spell-checking guidance to prohibit suppressing misspellings via .cspell.yaml and require proposals for legitimate technical terms.
  • Adds a matching “Spell check word list policy” section to AGENTS.md.
  • Adds explicit policy guardrails to .cspell.yaml comments and removes the “update as needed” phrasing.

Reviewed changes

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

File Description
CONTRIBUTING.md Replaces open-ended word-list guidance with a policy requiring fixes for misspellings and approvals for legitimate additions.
AGENTS.md Adds the same word-list policy so agents follow the same guardrails during changes.
.cspell.yaml Reinforces intent via PURPOSE comments and removes language that encouraged ad-hoc list changes.

💡 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 Malcolmnixon merged commit 328c2fa into main Mar 19, 2026
19 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/apply-pull-26-changes branch March 19, 2026 17:38
Copilot AI added a commit that referenced this pull request Mar 24, 2026
Malcolmnixon added a commit that referenced this pull request Mar 24, 2026
…) (#72)

* Initial plan

* Apply repo-consistency agent simplification from TemplateDotNetLibrary PR #63

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetTool/sessions/ce69fc58-b435-472a-971c-5f321320aa88

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
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