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
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

- [ ] `npm run check`
- [ ] `npm test`
- [ ] `npm run build` (required if this touches the build, `app.json`, or bridge commands)
- [ ] `npm run build` — **not run by CI**; required if this touches the build, `app.json`, or bridge commands
- [ ] Ran `npm run dev` and exercised the change in a real window

Steps you clicked through, and what you observed:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ jobs:
run: npm run check

# `native` asks before downloading its pinned Zig toolchain, and CI has no
# tty to answer, so pass --yes. The first zig-needing step fetches it; the
# cache above keeps later runs from re-downloading.
# tty to answer, so pass --yes. This step fetches it on a cold cache.
#
# CI does not run `npm run build`: the ReleaseFast build dominates the run
# time, and `native test` already compiles the app in Debug. Run
# `npm run build` locally before anything that touches the build graph.
- name: Test
run: npm test -- --yes

- name: Build
run: npm run build -- --yes
2 changes: 2 additions & 0 deletions .github/workflows/contributor-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ permissions:
jobs:
membership:
name: check author membership
# Bots open pull requests too (Dependabot), and they are never org members.
if: github.event.pull_request.user.type != 'Bot'
runs-on: ubuntu-latest
steps:
- name: Flag non-member pull requests
Expand Down
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,17 @@ pick a folder.
```sh
npm run check # markup, manifest, and core validation
npm test # Zig unit tests in src/main.zig
npm run build # release build — run for anything touching the build or manifest
npm run build # release build — CI does not run this, so run it yourself
```

`check`, `test`, and `build` all regenerate `frontend/dist/tree.js` first, so run
them before committing if you touched `frontend/tree.js`.

CI runs `check` and `test` only — the ReleaseFast build is too slow to gate every
pull request, and `native test` already compiles the app in Debug. That makes
`npm run build` your responsibility for anything touching the build graph,
`app.json`, or bridge commands: a release-only break will not be caught for you.

## Working in this codebase

The layout, invariants, and the bridge-command checklist live in
Expand Down
Loading