Document the README + HISTORY cspell CI scope (main-only)#414
Merged
Conversation
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](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #414 +/- ##
=======================================
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:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the intended CI spell-check scope for this repo’s user-facing docs, clarifying that cspell is enforced only for README.md and HISTORY.md while markdown linting remains repo-wide.
Changes:
- Adds an explicit “Spelling CI scope” item under CODESTYLE’s “Markdown and Spelling” section.
- Clarifies why CI does not gate
**/*.mdfor spelling, and notes that the CI/task file list must stay consistent (explicit file list, not a glob).
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