Repository navigation
docs: add AGENTS.md engineering protocol and CONTRIBUTING.md - #6
Conversation
Captures the headless-by-design constraints (no agents, no queues, no UI), the JSON contract stability expectations for NullHub consumers, and the standard validation gates.
DonPrus
left a comment
DonPrus
left a comment
There was a problem hiding this comment.
Reviewed the two new guides against README, the JSONL store, CLI/API entry points, build configuration, and the reused CI workflow. The headless product boundary and ownership split match the existing architecture, and the compatibility requirement is appropriate for NullHub consumers. No prior PR comments or reviews need resolution; the branch merges cleanly with current main. No runtime changes or unrelated additions.
One non-blocking correction: CONTRIBUTING says “4-target CI matrix,” but the delegated nullbuilder/.github/workflows/zig-ci.yml@v1 default has three jobs: Linux x86_64, macOS aarch64, and Windows x86_64. NullWatch does not override targets_json. It would be great to say “the shared CI matrix” so the guide stays accurate when the shared workflow changes. Also consider listing bash tests/test_e2e.sh for API/CLI changes, since CI runs it and it verifies real ingest/query behavior.
Approved. Validation here was a source/workflow comparison and clean merge-tree check; application tests were not rerun for these documentation-only additions.
|
Addressed both suggestions in e7c546e: "4-target CI matrix" → "the shared CI matrix" (nullwatch inherits the 3-job default and doesn't override |
2 participants
NullWatch had neither an AGENTS.md nor a CONTRIBUTING.md. Added both, capturing the README's headless-by-design constraints as an engineering protocol: what lives here (traces/evals/summaries, JSON API + CLI) and what must not (agents, queues, scheduling, UI), the JSON contract stability expectations for NullHub consumers, and the standard validation gates. Docs-only.