Skip to content

docs: add CONTRIBUTING.md #12

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 4, 2026
Merged

docs: add CONTRIBUTING.md #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d576bb2
docs: add CONTRIBUTING.md with commit gates and API-contract obligations
vernonstinebaker Sep 28, 2026
0a769bf
docs(contributing): describe what CI actually runs — 3 test jobs + 2 …
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
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing to nullTickets

1. **Read [AGENTS.md](AGENTS.md)** first — it defines the engineering protocol,
module map, and conventions for this repository.
2. One concern per PR. No drive-by refactors.
3. Before every commit:
- `zig build test --summary all` — 0 failures, 0 leaks
- `bash tests/test_e2e.sh` — end-to-end API flow must pass
- `zig fmt --check src/`
4. Every PR runs unit tests on Linux, macOS and Windows, plus Linux
aarch64/riscv64 cross-compilation. Keep it green.
5. Bug fixes must include a regression test citing the issue number.
6. REST API changes must keep `/openapi.json` and `/.well-known/openapi.json`
exports in sync — the tracker contract is consumed by agents and
orchestrators that depend on it.
Loading