Repository navigation
docs: add CONTRIBUTING.md - #87
Conversation
…ecycle hygiene rules
DonPrus
left a comment
There was a problem hiding this comment.
Checked the guide against AGENTS.md, README.md, build.zig, ui/package.json, the actual CI inputs and #86. The four-target matrix and native-Linux E2E description match the workflow. The lifecycle requirement is appropriate for the existing supervisor/CLI boundary, and the guide adds a contribution flow rather than duplicating the architecture documentation. It merges cleanly with current main.
One non-blocking improvement: it would be great to use bash tests/test_backend.sh as the backend gate (or list both commands from it). CI and README currently run both zig build test and zig build test-integration with -Dembed-ui=false -Dbuild-ui=false; the new checklist only mentions unit tests. Using the existing script keeps the instructions consistent, includes the real-process HTTP integration suite, and avoids an unnecessary UI build for backend-only checks.
No blocking findings in this documentation-only PR.
|
Addressed in d76930e — step 4 now uses That also fixes a second inaccuracy in the old line: it said Left the "4-target CI matrix" wording as-is — verified it's correct here: Docs-only, +20/-0 on one new file. CI running; approval retained. |
DonPrus
left a comment
There was a problem hiding this comment.
Rechecked d76930e against tests/test_backend.sh and .github/workflows/ci.yml. The contributor gate now matches both backend unit and integration checks, including the UI build flags. The four-target matrix remains accurate. The earlier nit is resolved; approval stands.
Adds the contribution flow: build prerequisites, commit gates (zig build test, zig fmt, ui build), the 4-target CI matrix including the e2e suite, the regression-test mandate, and a lifecycle-hygiene rule for instance process management (distilled from #86). Complements the existing AGENTS.md. Docs-only.