BitSquare/Codeman
2
0
Fork 0
mirror of https://github.com/Ark0N/Codeman.git synced 2026-10-10 09:19:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(wiki): say npm test is the CI gate, as CONTRIBUTING.md does

Browse Source 
The wiki's Contributing page still warned against bare npm test and pointed at test:ci, from before 947ff6f6 made npm test the CI gate and gave the browser, mobile and perf suites their own runners. It now matches .github/CONTRIBUTING.md and CLAUDE.md.
This commit is contained in:
JD
2026-10-08 00:35:36 -04:00
parent ac94f339ac
commit 9230b53ccd
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/wiki/Contributing.md
+8 -5
View File
@@ -43,8 +43,8 @@ npm run lint
npm run format:check npm run format:check
npm run check:frontend-syntax npm run check:frontend-syntax
npm run check:browser-excludes npm run check:browser-excludes
npm test -- test/<file>.test.ts # one file, the normal way npm test # the gate, exactly what CI runs
npm run test:ci # the full CI sweep npm test -- test/<file>.test.ts # one file
``` ```
`npm install` installs a `pre-push` git hook that runs the static checks above (about 10-40s, `npm install` installs a `pre-push` git hook that runs the static checks above (about 10-40s,
@@ -53,9 +53,12 @@ something other than the checked-out HEAD, or when the tree has uncommitted chan
checks would read. Skip it once with `CODEMAN_SKIP_PREPUSH=1 git push`; a checks would read. Skip it once with `CODEMAN_SKIP_PREPUSH=1 git push`; a
`pre-push` hook of your own is never overwritten. `pre-push` hook of your own is never overwritten.
**Never run bare `npm test`.** The default configuration includes browser-driven Playwright `npm test` runs the same suite CI runs, so a green run locally means a green run there. It
suites that need a live server, Chromium, and environment-specific baselines; they hang or leaves out three suites that cannot pass on an arbitrary machine, each with its own command:
fail on a normal machine. `test:ci` is the honest "run everything". `npm run test:browser` (Playwright, Chromium and a live server), `npm run test:mobile` (the
same plus environment-specific screenshot baselines) and `npm run test:perf` (wall-clock
benchmarks for an otherwise idle machine). Expect those to fail where the machine cannot
provide what they need; that means "not runnable here", not a regression.
Tests are tmux-safe by design: under vitest the tmux layer becomes an in-memory mock, so Tests are tmux-safe by design: under vitest the tmux layer becomes an in-memory mock, so
tests cannot touch real sessions. If you add a test that binds a port, pick a unique one at tests cannot touch real sessions. If you add a test that binds a port, pick a unique one at