docs: add agent contributor guide - #163
Open
owainlewis wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a concise repository-specific contributor guide for coding agents.
The guide focuses on rules that are difficult to infer safely from code:
It deliberately avoids a code map, source file names, and duplicated
implementation explanations. Agents are directed to the contributor and
architecture documentation for discoverable detail.
Why
Push had strong contributor and architecture documentation but no root
AGENTS.md. Important constraints were easy to miss, especially around cursorordering, durable delivery, backend session recovery, job replay, and security.
This adds a short, stable layer of project invariants without duplicating the
repository structure or details that will drift as the code changes.
Test plan
cargo fmt --all --checkcargo clippy --locked --all-targets -- -D warningscargo build --lockedcargo test --locked(367 tests passed)mkdocs build --strictgit diff --checkfindings
Risks
Low. This is contributor documentation only. The remaining maintenance risk is
that required commands or architecture invariants may change. The guide tells
agents to follow CI and the canonical project documentation for deeper detail.
Related issue
None.