Note the cspell gate scopes to whichever of README/HISTORY exists - #303
Merged
Conversation
Fleet deployment feedback (#302 rollout): some repos ship no HISTORY.md, and cspell errors on a listed file that does not exist. Clarify that the README + HISTORY default degrades to README-only where there is no changelog. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the repository style guide to clarify how the CI spelling gate should be scoped when a repo does not include both README.md and HISTORY.md, addressing fleet rollout feedback where cspell fails on missing files.
Changes:
- Clarifies the intended cspell CI scope (README/HISTORY) in
CODESTYLE.md. - Adds guidance for repos that do not ship
HISTORY.md(or other gated files).
Copilot review: the prior wording read as if the list auto-scoped. The cspell file list is explicit, so a repo without HISTORY.md must remove it from the workflow, task, and one-liner rather than relying on any automatic behavior. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727
added a commit
that referenced
this pull request
Jul 15, 2026
Promotion of the cspell-scope work from develop to main. - #302 — narrow CI cspell from all markdown to README.md + HISTORY.md; codify the rule + rationale in CODESTYLE.md; AGENTS.md clarifier. - #303 — note the list scopes to whichever of README/HISTORY the repo has (repos with no changelog gate on README alone). main still runs `**/*.md`; this brings it in line with the default. Trial-merged clean locally — the promotion touches only the 3 cspell files. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
This was referenced Jul 15, 2026
Merged
ptr727
added a commit
to ptr727/homeassistant-purpleair
that referenced
this pull request
Jul 15, 2026
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.md` only (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](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727
added a commit
to ptr727/NxWitness
that referenced
this pull request
Jul 15, 2026
Docs-only: append a new "Spelling CI scope" item (item 3) to the Markdown and Spelling list in CODESTYLE.md, documenting that the CI spell-check gate covers README.md + HISTORY.md only while broad live checking is the cspell editor extension's job. Propagates the template rule from ptr727/ProjectTemplate#302 and ptr727/ProjectTemplate#303. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- 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.
Feedback from the #302 fleet rollout: some repos (e.g. EspDinIoT,
releaseTrigger: none) ship no HISTORY.md, and cspell errors on a listed file that does not exist.Clarify in CODESTYLE.md § "Markdown and Spelling" that the README + HISTORY default scopes to whichever of the two the repo actually has — a repo with no changelog gates on README.md alone. Docs-only.
🤖 Generated with Claude Code