Document the README + HISTORY cspell CI scope in CODESTYLE - #221
Merged
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
Updates the repository’s CODESTYLE documentation to clarify that CI spell-checking (cspell) is intentionally scoped to the user-facing docs, aligning this repo with the upstream template guidance.
Changes:
- Document that the CI spell-check gate is limited to
README.mdandHISTORY.md. - Clarify the rationale for not gating cspell on all
**/*.md, while keeping markdown linting repo-wide.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #221 +/- ##
========================================
Coverage 99.53% 99.53%
========================================
Files 7 7
Lines 860 860
Branches 118 118
========================================
Hits 856 856
Partials 4 4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 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 free
to 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 change: append CODESTYLE item 3 "Spelling CI scope" under Markdown and Spelling, documenting that the enforced CI spell-check gate covers
README.md+HISTORY.mdonly (not all markdown), with broad live checking left to the cspell editor extension. Propagates the template rule from ptr727/ProjectTemplate#302 and ptr727/ProjectTemplate#303.🤖 Generated with Claude Code