Add versioning and markdown-hygiene rules, enforce cspell en-US - #230
Merged
Conversation
cspell: set language to en-US (a bare en accepts British spellings, silently passing the wrong spelling against the US-English rule); document the requirement in CODESTYLE and name it in the spec recurring.spelling assertion so it is machine-checkable. Verified 0 issues across all .md with the CI cspell image. Versioning (#228 s4): docs reference the 2-digit major.minor line, never a 3-digit build; issue-closing keywords go on the develop->main promotion PR (GitHub auto-closes only from the default branch). Markdown hygiene (#228 s7): URLs in fenced code blocks stay inline (reference links do not resolve there; exclude code from link-integrity checks), and removing a link also removes its orphaned reference definition. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines the repo's governance and validation rules by tightening US-English spelling enforcement (via CSpell locale), and by documenting/encoding additional versioning and markdown-hygiene rules derived from issue #228.
Changes:
- Enforce US-English spellings by switching
cspell.jsonlocale fromentoen-US, and document the rationale inCODESTYLE.md. - Extend the project-type spec to explicitly assert the
en-USlocale requirement for spelling audits. - Add versioning and markdown-hygiene rules to
AGENTS.md(2-digitmajor.minorin docs; issue-closing keywords only ondevelop -> mainpromotion PRs; fenced-code link handling guidance).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| spec/project-types.json | Strengthens the spelling audit assertion to require cspell.json locale en-US. |
| cspell.json | Sets CSpell locale to en-US to flag British spellings. |
| CODESTYLE.md | Documents the en-US locale requirement and why bare en is insufficient. |
| AGENTS.md | Adds versioning and markdown-hygiene governance rules to prevent recurring doc/process regressions. |
Uh oh!
There was an error while loading. Please reload this page.
The assertion references the cspell en-US config, which is documented in CODESTYLE's Markdown and Spelling section, not the AGENTS PR-title section the intentRef named. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.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 freeto 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.
Encodes #228 §4 (versioning) and §7 (markdown hygiene), plus the maintainer-flagged cspell
en-USfix. Slim, additive governance-doc refinements.en-US(§7 / maintainer todo).cspell.jsonlanguagewas a bareen, which accepts British spellings and silently contradicts the US-English rule. Set it toen-US, document the requirement in CODESTYLE's Spelling rule, and name it in the specrecurring.spellingassertion so the audit catches it fleet-wide. Verified 0 issues across all.mdwith the CI cspell image.major.minorline, never a 3-digit build (NBGV owns the patch; "correcting"1.0to1.0.0is a defect that has blocked a release). Issue-closing keywords (Closes #N) go on thedevelop -> mainpromotion PR, not the feature/develop PR - GitHub auto-closes only from the default branch.Deferred per maintainer guidance: §0 platform framing, §2 editor/scripts snippets, §3 HA profile, devcontainer, and the Python/HA repo audits. Next up is the stable C#/Docker repo audits.
🤖 Generated with Claude Code