Skip to content

docs: add CONTRIBUTING.md #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vernonstinebaker merged 2 commits into from
Oct 3, 2026
Merged

docs: add CONTRIBUTING.md #87

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
997303b
docs: add CONTRIBUTING.md with commit gates, CI expectations, and lif…
vernonstinebaker Sep 28, 2026
d76930e
docs(contributing): use tests/test_backend.sh as the backend gate (Do…
vernonstinebaker Oct 3, 2026
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
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing to NullHub

1. **Read [AGENTS.md](AGENTS.md)** and [README.md](README.md) first — the
architecture (embedded Svelte UI, installer, supervisor) and runtime
prerequisites are documented there.
2. One concern per PR. No drive-by refactors.
3. Build prerequisites: `npm` (UI build), `zig` 0.16.0.
4. Before every commit:
- `bash tests/test_backend.sh` — the backend gate CI actually runs; wraps
`zig build test` + `zig build test-integration`, both with
`-Dembed-ui=false -Dbuild-ui=false` — 0 failures, 0 leaks
- `zig fmt --check src/`
- UI-touching changes: `npm --prefix ui run build` must succeed
5. Every PR runs the 4-target CI matrix (linux-x86_64, linux-aarch64,
macos-aarch64, windows-x86_64) including backend tests and the e2e suite
on the native Linux target. Keep it green.
6. Bug fixes must include a regression test citing the issue number.
7. Changes to instance lifecycle (install/restart/uninstall) must account for
process-tree hygiene: the supervisor owns child processes, and restarts
must leave exactly one process per instance (see #86).
Loading