Document the README + HISTORY cspell CI scope in CODESTYLE#413
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 PR updates the repository’s documentation standards by explicitly defining the scope of the CI spelling gate in CODESTYLE.md, clarifying that CI enforces spelling only for the primary user-facing docs while broader spell-checking remains an editor responsibility.
Changes:
- Add a new “Spelling CI scope” guideline to document that CI cspell checks only
README.mdandHISTORY.md. - Explain why CI does not spell-check all
**/*.md, and note the need to keep the CI workflow, VS Code task, and docs 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 #413 +/- ##
========================================
Coverage 66.89% 66.89%
========================================
Files 13 13
Lines 1160 1160
Branches 108 108
========================================
Hits 776 776
Misses 338 338
Partials 46 46 ☔ 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: appends a new list item 3 "Spelling CI scope" to the Markdown and Spelling section of CODESTYLE.md, propagating the template's CODESTYLE Spelling-CI-scope rule (ptr727/ProjectTemplate#302, #303). It documents that the CI spell-check gate covers README.md + HISTORY.md only, not all markdown, with broad live checking left to the cspell editor extension.
🤖 Generated with Claude Code