Repository navigation
docs: add AGENTS.md and expand CONTRIBUTING.md - #67
Merged
Merged
Conversation
Describe the checks CI requires, the generated and hand-written protocol code, how to update the vendored proto, how dependency updates merge, the commit rules, and the release steps. AGENTS.md gives AI agents the short version and the README points to both files. Signed-off-by: Jonasz Małecki <jonasz@upbound.io>
jonasz-lasut
force-pushed
the
docs/agents-and-contributing
branch
from
November 19, 2026 09:00
b3cae47 to
31f74d5
Compare
jonasz-lasut
marked this pull request as ready for review
November 19, 2026 09:02
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.
Adds
AGENTS.mdwith short rules for AI agents, a README section that points agents to it, and a longerCONTRIBUTING.md. The contributing guide now covers the checks CI requires, the generated and hand-written protocol code, the steps to update the vendored proto, how Renovate updates merge, the commit rules, and the release steps.This is stacked on #65, because the proto steps describe
sdk/src/proto/state.rsfrom that PR. The guide also says Renovate doesn't merge proto updates by itself, which is true once #66 merges.