Document the README + HISTORY cspell CI scope (main-only)#275
Merged
Conversation
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.md` only while broad live checking stays in the editor extension. Propagates the rule from the template (ptr727/ProjectTemplate#302, #303). 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the intentional CI spell-check scope in CODESTYLE.md, clarifying that the enforced gate is limited to the two most user-facing docs while still encouraging broad editor-time spell checking.
Changes:
- Add a dedicated “Spelling CI scope” section describing why CI gates only
README.mdandHISTORY.md. - Clarify that CI spell-checking uses an explicit file list (not a glob) and must stay aligned across CI and local tooling.
- Reiterate that markdown linting remains repo-wide (
**/*.md).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #275 +/- ##
=======================================
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:
|
This was referenced Jul 16, 2026
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.
Cherry-picks the CODESTYLE "Spelling CI scope" documentation onto main, without dragging the unrelated in-flight work currently on develop. Docs-only; the same change is already on develop.
🤖 Generated with Claude Code