ci: spell-check site copy with codespell (closes #14)#23
Merged
Conversation
Public-facing marketing copy had no spell check — a typo ships silently. - .codespellrc: scan the repo (skipping build output, node_modules, binaries, and the generated data/releases.json). - .codespell-ignore: project dictionary for crypto/Monero/Tari jargon (monerod, pplns, p2pool, tari, xvb, onion, stratum, xmrig, …). - ci.yml: new "spell" job runs codespell (pinned 2.4.2 via pipx). - CONTRIBUTING: document running it locally and where to allow-list terms. Optional Vale prose-lint from the issue is deferred — codespell covers the spelling acceptance; Vale can land later as a non-blocking follow-up. Verified locally: codespell clean over the whole repo; prettier/markdownlint clean; zizmor clean. 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
1 participant
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.
Resolves #14. The public-facing marketing copy in
data/content.yaml+layouts/had no spell check — a typo ships silently.What this adds
.codespellrc— scans the repo, skipping build output (public,resources),node_modules, binaries, and the generateddata/releases.json..codespell-ignore— project dictionary for crypto/Monero/Tari jargon:monerod,pplns,p2pool,tari,xvb,onion,stratum,xmrig, …ci.yml— a newspelljob runscodespell(pinned 2.4.2 viapipx run).pipx run codespell .) and where to allow-list a new domain term.Scope note
The issue's optional Vale prose-lint is deferred — codespell satisfies the spelling acceptance; Vale (wordiness/passive, non-blocking) can land later as a follow-up if wanted. Flag it if you'd like Vale in this PR.
Acceptance (#14)
Verified locally
codespell .→ clean over the whole repo (and it correctly catches injected typos)🤖 Generated with Claude Code