chore: add AGENTS.md with agent-specific conventions#35
Merged
Conversation
Captures two recurring footguns that have bitten automated commits in this repo: - Pushes using the maintainer's private gmail address are rejected by GitHub (GH007). All commits and tags must use the noreply identity 120051+leodido@users.noreply.github.com. - README.md is user-facing; CONTRIBUTING.md owns API governance (Check vs ProbeWith, addition checklist, FromELF contract, gated-vs-probe-only classification). Agents should not regress this split when editing docs. Also documents the tag-driven release flow and the no-commit/push- without-approval rule.
This was referenced May 3, 2026
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
1 participant
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.
Motivation
Two recurring footguns have surfaced in automated work on this repo and need a stable home so agents (and future-me) stop relearning them:
GH007). Every commit/tag must use120051+leodido@users.noreply.github.com. The recovery dance (amend / re-tag / re-push) eats time on every release and feature branch.FromELFcontract, gated-vs-probe-only classification) out of the README intoCONTRIBUTING.md. Without an explicit note, agents will silently re-mix them on the next docs change.Changes
New top-level
AGENTS.mdcovering:GH007).README.mdvsCONTRIBUTING.md, and the rule for changes that touch both)..github/workflows/release.yaml).Out of scope
No code or other doc changes.
AGENTS.mdis metadata only; CI is unaffected.