Skip to content

Scope CI spell-check to README and HISTORY by default - #302

Merged
ptr727 merged 2 commits into
developfrom
fix/cspell-ci-scope-readme-history
Jul 15, 2026
Merged

Scope CI spell-check to README and HISTORY by default#302
ptr727 merged 2 commits into
developfrom
fix/cspell-ci-scope-readme-history

Conversation

@ptr727

@ptr727 ptr727 commented Jul 15, 2026

Copy link
Copy Markdown
Owner

Problem

The CI cspell gate runs over all **/*.md. That was never the agreed default. The intended default is README.md + HISTORY.md only — the two files every repo visitor sees:

  • Repos carry many markdown files full of technical terms; gating every one through CI means endlessly padding cspell.json just to keep CI green — infeasible at fleet scale.
  • Broad, live spell-checking across any file (source, markdown, text) is the cspell editor extension's job, so typos still surface to whoever is editing.

The authoritative doc (CODESTYLE.md) was silent on CI scope, so the workflow silently drifted to **/*.md — and the whole local fleet inherited it.

Change

  • test-pull-request.yml: narrow the cspell step from **/*.md to README.md + HISTORY.md (via the action's multiline files:).
  • CODESTYLE.md § Markdown and Spelling: codify the README+HISTORY default and its rationale (root-cause fix — gives future drift something to check against).
  • AGENTS.md: make the cspell CI scope explicit (README+HISTORY, matching the one-liner); note markdownlint stays repo-wide.

markdownlint stays repo-wide **/*.md — it does not choke on technical terms. This is cspell-only.

Follow-up

This is the canonical (template) fix. A fleet sweep to narrow every downstream repo's CI cspell to the same default follows separately.

Validation

Local actionlint, markdownlint-cli2, and cspell all clean on the edited files.

🤖 Generated with Claude Code

@ptr727 @claude
Scope CI spell-check to README and HISTORY by default
7abe42a 
The CI cspell gate ran over all `**/*.md`, which was never the agreed
default: repos carry many markdown files full of technical terms, so
gating every one of them means endlessly padding cspell.json just to
keep CI green. The agreed default is README.md + HISTORY.md - the two
files every repo visitor sees - with broad live spell-checking left to
the cspell editor extension (any file, while editing).

Narrow the cspell CI step to README + HISTORY, and codify the rule and
its rationale in CODESTYLE.md "Markdown and Spelling" (the authoritative
doc was silent on CI scope, which is why the workflow drifted). markdownlint
stays repo-wide - it does not choke on technical terms.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 15, 2026 15:48
Copilot AI reviewed Jul 15, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aligns the template CI spelling gate with the intended default: enforce CSpell only on README.md and HISTORY.md, and document that contract so downstream repos have a stable reference.

Changes:

  • Narrow the CI CSpell file scope in .github/workflows/test-pull-request.yml from all Markdown to README.md + HISTORY.md.
  • Codify the intended CSpell CI scope (and rationale) in CODESTYLE.md.
  • Make the CI scope explicit in AGENTS.md so the documented local/CI guidance stays consistent.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
CODESTYLE.md Documents the default CI CSpell scope (README + HISTORY) and rationale alongside existing Markdown/spelling rules.
AGENTS.md Updates the CI linter description to explicitly call out the narrowed CSpell scope (while Markdown lint remains repo-wide).
.github/workflows/test-pull-request.yml Implements the narrowed CSpell gate by listing README.md and HISTORY.md in the action inputs.

Comment thread .github/workflows/test-pull-request.yml Outdated
@ptr727 @claude
Condense the cspell-scope comment to repo hygiene convention
0c673c9 
Copilot review: the comment exceeded the one-line-default convention.
Trim to two lines and defer the full rationale to CODESTYLE.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 15, 2026 15:52
Copilot AI reviewed Jul 15, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 6b694f9 into develop Jul 15, 2026
7 checks passed
@ptr727
ptr727 deleted the fix/cspell-ci-scope-readme-history branch July 15, 2026 15:54
This was referenced Jul 15, 2026
Merged
Merged
ptr727 added a commit to ptr727/NxWitness that referenced this pull request Jul 15, 2026
@ptr727 @claude
Scope CI spell-check to README and HISTORY (#512)
1509a7f 
Narrows the CI cspell (spell-check) step in
`.github/workflows/validate-task.yml` from all markdown (`**/*.md`) to
just `README.md` + `HISTORY.md`.

Matches the template default in ptr727/ProjectTemplate#302:
spell-checking every markdown file forces endlessly padding
`cspell.json` with technical terms. Restricting the gate to the two
files every repo visitor sees keeps CI meaningful, while broad live
spell-checking stays the editor extension's job.

- markdownlint stays repo-wide (`**/*.md`) - unchanged.
- Local `actionlint` (rhysd/actionlint:latest) is clean, no findings.

🤖 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/ESPHome-Config that referenced this pull request Jul 15, 2026
@ptr727 @claude
Scope CI spell-check to README and HISTORY (#42)
27dac79 
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 ptr727 mentioned this pull request Jul 15, 2026
Merged
ptr727 added a commit that referenced this pull request Jul 15, 2026
@ptr727 @claude
Note the cspell gate scopes to whichever of README/HISTORY exists (#303)
1693f60 
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](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ptr727 ptr727 mentioned this pull request Jul 15, 2026
Merged
ptr727 added a commit that referenced this pull request Jul 15, 2026
@ptr727
Promote: scope CI spell-check to README + HISTORY (#302, #303) (#304)
8f8d65b 
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
Merged
ptr727 added a commit to ptr727/NxWitness that referenced this pull request Jul 15, 2026
@ptr727 @claude
Scope CI spell-check to README + HISTORY (main-only) (#515)
56c96f8 
Cherry-picks the CI cspell-scope fix onto main, without dragging the
other in-flight work currently on develop.

This narrows the CI spell-check on **main** from all markdown
(`**/*.md`) **to** README.md + HISTORY.md, matching template PR
ptr727/ProjectTemplate#302. markdownlint stays repo-wide. The same
change is already on develop; this is the surgical main-only path so the
feature/dependency work on develop is not promoted with it.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jul 15, 2026
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
ptr727 added a commit to ptr727/Utilities that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#413)
f61db31 
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>
ptr727 added a commit to ptr727/LanguageTags that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#274)
7d494e8 
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>
ptr727 added a commit to ptr727/aiopurpleair that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#39)
7b35cf0 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727 added a commit to ptr727/homeassistant-purpleair that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#221)
1c09d8b 
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/PlexCleaner that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#846)
b01e787 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727 added a commit to ptr727/ESPHome-NonRoot that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#153)
f108172 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727 added a commit to ptr727/VSCode-Server-DotNetCore that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#94)
1ee7e47 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

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
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#516)
15d087f 
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>
ptr727 added a commit to ptr727/ESPHome-Config that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#44)
e4b33bb 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ptr727 ptr727 mentioned this pull request Jul 15, 2026
Open
ptr727 added a commit to ptr727/PlexCleaner that referenced this pull request Jul 15, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#846)
8f9cc53 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727 added a commit to ptr727/ESPHome-Config that referenced this pull request Jul 22, 2026
@ptr727 @claude
Scope CI spell-check to README and HISTORY (#42)
a272b12 
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 to ptr727/ESPHome-Config that referenced this pull request Jul 22, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#44)
90aeea2 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727 added a commit to ptr727/ESPHome-Config that referenced this pull request Jul 22, 2026
@ptr727 @claude
Scope CI spell-check to README and HISTORY (#42)
b73edd7 
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 to ptr727/ESPHome-Config that referenced this pull request Jul 22, 2026
@ptr727 @claude
Document the README + HISTORY cspell CI scope in CODESTYLE (#44)
7386a61 
* Document the README + HISTORY cspell CI scope in CODESTYLE

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>

* Reword the cspell-scope item to not name template-only surfaces

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727