Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .codespell-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
monerod
pplns
p2pool
tari
xvb
onion
pithead
rigforge
stratum
tor
xmrig
5 changes: 5 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[codespell]
# Spell-check public-facing copy and docs. https://github.com/codespell-project/codespell
# Crypto/Monero/Tari jargon (XMR, monerod, PPLNS, Tari, …) lives in .codespell-ignore.
skip = .git,node_modules,public,resources,package-lock.json,data/releases.json,*.svg,*.png,*.ico,*.woff,*.woff2
ignore-words = .codespell-ignore
12 changes: 12 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,15 @@ jobs:
run: npm run format:check
- name: markdownlint
run: npm run lint:md

spell:
name: Spell check (codespell)
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false # zizmor: artipacked
# pipx is preinstalled on ubuntu runners. Config + dictionary: .codespellrc / .codespell-ignore.
- name: Run codespell
run: pipx run codespell==2.4.2 .
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ not in the templates. See the [README](README.md#where-the-content-lives) for th

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

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

## Secret scanning

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