Conversation
## 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](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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>
Contributor
There was a problem hiding this comment.
Pull request overview
Promotes the develop change that narrows the CI CSpell gate to the repo’s visitor-facing Markdown (README + HISTORY) and documents the rationale so the template’s intended default is explicit and less likely to drift.
Changes:
- Update CI cspell-action inputs to check only
README.mdandHISTORY.md(while keeping markdownlint repo-wide). - Codify the intended CI spelling scope and rationale in
CODESTYLE.md. - Clarify the CI vs local lint surface behavior in
AGENTS.mdto match the workflow and documented rule.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CODESTYLE.md | Documents the default CI spelling gate scope (README + HISTORY) and the rationale/tradeoffs. |
| AGENTS.md | Updates the “CI (authoritative)” linter summary to reflect the narrowed cspell scope. |
| .github/workflows/test-pull-request.yml | Narrows the cspell CI step to README.md + HISTORY.md while keeping markdownlint on **/*.md. |
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.
Promotion of the cspell-scope work from develop to main.
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