Repository navigation
docs: add CONTRIBUTING.md - #12
Conversation
DonPrus
left a comment
There was a problem hiding this comment.
The contribution guide usefully complements the existing AGENTS.md rather than introducing a second engineering protocol. I checked its commands against build.zig, the E2E script and CI, checked the linked file, and verified the OpenAPI routes share the embedded src/openapi.json contract. The documentation-only change merges cleanly with current main.
One non-blocking correction: it would be great to replace “4-target CI matrix” with “unit tests on Linux, macOS and Windows, plus Linux aarch64/riscv64 cross-compilation.” The actual workflow has three test jobs; the two additional Linux architectures are build-only checks, and riscv64 is currently omitted from this list. This makes the contribution requirements match what CI really verifies.
For context, main's current configuration-test compilation failure is independently addressed and validated in #13; it is not introduced by this documentation PR. No blocking findings here.
…build-only cross-compiles (DonPrus review)
|
Addressed in 0a769bf — item 4 now reads "unit tests on Linux, macOS and Windows, plus Linux aarch64/riscv64 cross-compilation", i.e. your wording. Verified against Docs-only, +15/-0 on one new file. CI running; approval retained. |
Adds the contribution flow (commit gates: zig build test, e2e suite, zig fmt; CI matrix expectations; regression-test mandate; OpenAPI sync obligation for REST changes). Complements the existing AGENTS.md, which stays the engineering protocol. Docs-only.