Skip to content

Commit e03d1d8

Browse files
committed
ci: add spellcheck workflow and contributor guidance
1 parent 9ae17b4 commit e03d1d8

4 files changed

Lines changed: 75 additions & 2 deletions

File tree

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,4 @@
5151
- [ ] `README.md` Repository Structure section updated if files were added or removed
5252
- [ ] `CHANGELOG.md` updated
5353
- [ ] `TODO.md` updated if a tracked item is completed or a new one added
54+
- [ ] `npm run spellcheck` passes

.github/workflows/spellcheck.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Spellcheck
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "README.md"
7+
- "CONTRIBUTING.md"
8+
- "SECURITY.md"
9+
- "CHANGELOG.md"
10+
- "TODO.md"
11+
- "docs/**"
12+
- "cspell.json"
13+
- "package.json"
14+
- "package-lock.json"
15+
- ".github/pull_request_template.md"
16+
- ".github/workflows/spellcheck.yml"
17+
push:
18+
branches:
19+
- main
20+
paths:
21+
- "README.md"
22+
- "CONTRIBUTING.md"
23+
- "SECURITY.md"
24+
- "CHANGELOG.md"
25+
- "TODO.md"
26+
- "docs/**"
27+
- "cspell.json"
28+
- "package.json"
29+
- "package-lock.json"
30+
- ".github/pull_request_template.md"
31+
- ".github/workflows/spellcheck.yml"
32+
33+
permissions:
34+
contents: read
35+
36+
jobs:
37+
spellcheck:
38+
runs-on: ubuntu-latest
39+
40+
steps:
41+
- name: Checkout
42+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
43+
44+
- name: Setup Node.js
45+
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
46+
with:
47+
node-version: 22
48+
cache: npm
49+
50+
- name: Install dependencies
51+
run: npm ci
52+
53+
- name: Run spellcheck
54+
run: npm run spellcheck

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ A [pull request template](.github/pull_request_template.md) is pre-filled when y
88

99
## Pre-commit Checklist
1010

11+
For documentation and repo-housekeeping changes, install the local tooling once and run:
12+
13+
```powershell
14+
npm install
15+
npm run spellcheck
16+
```
17+
1118
### Agent changes (`reframe.agent.md`)
1219

1320
- [ ] Instructions are clear, unambiguous, and internally consistent
@@ -40,6 +47,7 @@ A [pull request template](.github/pull_request_template.md) is pre-filled when y
4047
- [ ] `README.md` Repository Structure section reflects any new/removed files
4148
- [ ] `CHANGELOG.md` updated
4249
- [ ] `TODO.md` updated if a tracked item is completed or a new one is added
50+
- [ ] `npm run spellcheck` passes
4351

4452
---
4553

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Installs the agent to your VS Code user prompts folder so `@ReFrame` is availabl
4343
irm https://raw.githubusercontent.com/CTOUT/ReFrame/main/install.ps1 | iex
4444
```
4545

46-
> **Note:** User-level installs do not include the `knowledge/` files. Game-specific profiles (Tier 1) and per-engine JSON defaults (Tier 2) are unavailable — the agent falls back to its embedded engine defaults and web lookups. For full knowledge base coverage, use the repo-level install above.
4746
> **Note:** User-level installs do not include the `knowledge/` files. Game-specific profiles (Tier 1) and per-engine JSON defaults (Tier 2) are unavailable — the agent falls back to generic best-practice rules (Tier 3) and web lookups when needed. For full knowledge base coverage, use the repo-level install above.
4847
4948
### Manual install
@@ -143,7 +142,8 @@ ReFrame/
143142
│ │ ├── registry-analysis/ ← on-demand registry review
144143
│ │ └── system-scan/ ← hardware detection skill
145144
│ ├── workflows/
146-
│ │ └── release.yml ← GitHub Actions release workflow
145+
│ │ ├── release.yml ← GitHub Actions release workflow
146+
│ │ └── spellcheck.yml ← Documentation spellcheck CI
147147
│ └── CODEOWNERS
148148
├── .vscode/
149149
│ └── extensions.json
@@ -161,9 +161,12 @@ ReFrame/
161161
├── CHANGELOG.md
162162
├── CITATION.cff
163163
├── CONTRIBUTING.md
164+
├── cspell.json
164165
├── install.ps1
165166
├── LICENSE
166167
├── llms.txt ← AI crawler guidance
168+
├── package-lock.json
169+
├── package.json
167170
├── README.md
168171
├── SECURITY.md
169172
└── TODO.md
@@ -207,6 +210,13 @@ No. The agent works entirely offline using your local knowledge base and system
207210

208211
See [CONTRIBUTING.md](CONTRIBUTING.md).
209212

213+
For documentation and repo-housekeeping changes, run the spellcheck before opening a PR:
214+
215+
```powershell
216+
npm install
217+
npm run spellcheck
218+
```
219+
210220
## Security
211221

212222
See [SECURITY.md](SECURITY.md) for reporting vulnerabilities and installer verification guidance.

0 commit comments

Comments
 (0)