Scope CI spell-check to README and HISTORY - #42
Merged
Conversation
Match the template default (ptr727/ProjectTemplate#302): the CI cspell gate covered all markdown, which forces endlessly padding cspell.json for technical terms. Narrow it to README.md + HISTORY.md - the files every repo visitor sees; broad live spell-checking stays the editor extension's job. markdownlint stays repo-wide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR narrows the GitHub Actions CI spell-check (cspell) scope in the pull request workflow so it checks only the two visitor-facing docs (README.md and HISTORY.md) instead of all Markdown files, while leaving markdownlint unchanged.
Changes:
- Update the cspell action
files:input from**/*.mdto a two-file list (README.md,HISTORY.md). - Keep the existing repo-wide Markdown linting (
globs: '**/*.md') as-is.
ptr727
added a commit
that referenced
this pull request
Jul 22, 2026
Match the template default (ptr727/ProjectTemplate#302): the CI cspell gate covered all markdown, which forces endlessly padding cspell.json for technical terms. Narrow it to README.md + HISTORY.md - the files every repo visitor sees; broad live spell-checking stays the editor extension's job. markdownlint stays repo-wide. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727
added a commit
that referenced
this pull request
Jul 22, 2026
Match the template default (ptr727/ProjectTemplate#302): the CI cspell gate covered all markdown, which forces endlessly padding cspell.json for technical terms. Narrow it to README.md + HISTORY.md - the files every repo visitor sees; broad live spell-checking stays the editor extension's job. markdownlint stays repo-wide. 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.
Narrows the CI cspell step in
.github/workflows/test-pull-request.ymlso it checks onlyREADME.md+HISTORY.mdinstead of all markdown (**/*.md).Why
Matches the template default in ptr727/ProjectTemplate#302. Spell-checking all markdown in CI forces endlessly padding
cspell.jsonwith technical terms that appear in device/config docs. The README and HISTORY are the files every repo visitor sees, so those stay gated; broad live spell-checking remains the editor extension's job.Scope
files:value changed.markdownlintstays repo-wide (**/*.md) - unchanged.🤖 Generated with Claude Code