Document the README + HISTORY cspell CI scope in CODESTYLE - #274
Merged
Conversation
Propagate the CODESTYLE "Spelling CI scope" rule from the template (ptr727/ProjectTemplate#302, #303): the CI spell-check gate covers README.md + HISTORY.md, not all markdown, with broad live checking left to the editor extension. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This docs-only PR updates the repository C# style guide (CODESTYLE.md) to explicitly document the intended scope of the CI spelling gate: CI enforces CSpell on README.md and HISTORY.md only, while broad spell-checking remains an editor responsibility.
Changes:
- Add a new “Spelling CI scope” item clarifying that CI spell-checking is limited to
README.md+HISTORY.md. - Explain why CI does not gate on all
**/*.md, and note that the workflow, VS Code task, and AGENTS guidance should stay aligned on the same explicit file list.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@## develop #274 +/- ##
========================================
Coverage 87.43% 87.43% ========================================
Files 11 11 Lines 1973 1973 Branches 243 243 ========================================
Hits 1725 1725 Misses 166 166 Partials 82 82 🚀 New features to boost your workflow:
|
Copilot review: the item referenced a Lint: Spelling VS Code task and an AGENTS.md cspell one-liner that exist in the template but not in this repo. Reword generically so the guidance is accurate regardless of which local cspell surfaces a repo actually has. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs-only: appends CODESTYLE item 3 "Spelling CI scope" to the Markdown and Spelling list, documenting that the CI spell-check gate covers
README.md+HISTORY.mdonly while broad live checking stays in the editor extension. Propagates the rule from the template (ptr727/ProjectTemplate#302, #303).🤖 Generated with Claude Code