Skip to content

docs: add AGENTS.md engineering protocol and CONTRIBUTING.md - #55

Merged
vernonstinebaker merged 2 commits into
mainfrom
docs/agents-and-contributing
Oct 3, 2026
Merged

vernonstinebaker merged 2 commits into
mainfrom
docs/agents-and-contributing

Conversation

@vernonstinebaker

Copy link
Copy Markdown
Contributor

NullBoiler was the only main null-stack repo with neither an AGENTS.md nor a CONTRIBUTING.md (CLAUDE.md carries the module map, which stays authoritative there).

Docs-only; no code changes.

Consolidates the working conventions from recent orchestration work
(A2A worker URL base convention, strict template rendering, FSM trigger
naming, stored-workflow persistence) and the contribution flow with CI
expectations. Module map remains in CLAUDE.md.

@DonPrus DonPrus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked the architecture notes against current main, the linked fixes/issues, the reusable CI configuration, and the existing CLAUDE.md. Referencing the existing module map avoids maintaining a duplicate map. The A2A URL convention, expanded-workflow persistence and published tracker snapshot match the merged code. I also checked the vendored hiredis/mosquitto sources and listener loops: the warning that those transports are stubs is justified despite their implemented-looking wrappers. Both new files merge cleanly.

One documentation clarification would be useful: on_failure.transition_to is not currently applied. Tracker.driveFailed reads on_failure.retry and eventually calls failRun; it never reads the failure transition. #52 was closed without merging. It would be great to describe the trigger naming as the intended contract while explicitly listing the unimplemented failure-transition path among the known gaps. on_success.transition_to is implemented. This avoids telling future contributors that both paths already work.

This is a pre-existing implementation gap rather than a regression from these docs; approving with that non-blocking clarification.

@vernonstinebaker

Copy link
Copy Markdown
Contributor Author

Addressed in 18c7814, both parts of your clarification:

Verified against source before writing: transition_to appears in only 3 files, and in tracker.zig only at 1367-1368 (the success path); from_json.zig/workflow_loader.zig handle parsing only. No merged PR closes #52.

Docs-only, +76/-0 across two new files. CI running; approval retained.

@DonPrus DonPrus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rechecked 18c7814 against tracker.zig and workflow_loader.zig. The guide now correctly distinguishes the implemented success trigger from the parsed-but-unapplied failure transition and lists the latter as a known gap. The earlier documentation nit is resolved; approval stands.

@vernonstinebaker
vernonstinebaker merged commit 1bffb7d into main Oct 3, 2026
4 checks passed
@vernonstinebaker
vernonstinebaker deleted the docs/agents-and-contributing branch October 3, 2026 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants