Skip to content

Commit 1879b4f

Browse files
VijitSingh97claude
andcommitted
ci: spell-check site copy with codespell (closes #14)
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>
1 parent 0c15f6e commit 1879b4f

4 files changed

Lines changed: 32 additions & 0 deletions

File tree

.codespell-ignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
monerod
2+
pplns
3+
p2pool
4+
tari
5+
xvb
6+
onion
7+
pithead
8+
rigforge
9+
stratum
10+
tor
11+
xmrig

.codespellrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[codespell]
2+
# Spell-check public-facing copy and docs. https://github.com/codespell-project/codespell
3+
# Crypto/Monero/Tari jargon (XMR, monerod, PPLNS, Tari, …) lives in .codespell-ignore.
4+
skip = .git,node_modules,public,resources,package-lock.json,data/releases.json,*.svg,*.png,*.ico,*.woff,*.woff2
5+
ignore-words = .codespell-ignore

.github/workflows/ci.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,15 @@ jobs:
7272
run: npm run format:check
7373
- name: markdownlint
7474
run: npm run lint:md
75+
76+
spell:
77+
name: Spell check (codespell)
78+
runs-on: ubuntu-latest
79+
steps:
80+
- name: Checkout
81+
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
82+
with:
83+
persist-credentials: false # zizmor: artipacked
84+
# pipx is preinstalled on ubuntu runners. Config + dictionary: .codespellrc / .codespell-ignore.
85+
- name: Run codespell
86+
run: pipx run codespell==2.4.2 .

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ not in the templates. See the [README](README.md#where-the-content-lives) for th
3535

3636
4. Update the README or other docs for any user-facing change.
3737

38+
CI also runs Prettier + markdownlint (`npm run lint`) and a spell check. Run the spell check
39+
locally with `pipx run codespell .` — domain jargon (XMR, monerod, PPLNS, Tari, …) is allow-listed
40+
in [`.codespell-ignore`](.codespell-ignore); add new terms there if a real word is flagged.
41+
3842
## Secret scanning
3943

4044
CI runs [gitleaks](https://github.com/gitleaks/gitleaks) over the full history on every push and PR,

0 commit comments

Comments
 (0)