Repository navigation
Conversation
Document the conventions that reviews of past pull requests have settled on, so agent-written contributions follow them and are easier to review. Point to it from the README, and match the README flake8 command to CI.
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.
More pull requests here are now written with coding agents, and that is only going to grow. This adds an
AGENTS.mdto set those contributions up for success and make them easier to review. It doesn't introduce new rules; it writes down what has already been happening in review.The guidance is based on review feedback across the roughly 50 pull requests from the last year, especially @josegonzalez's comments. For example, "simple to read/understand, follows patterns in the codebase, doesn't break existing functionality" (#474), splitting large pull requests (#500), and preferring the standard library (#533). The rest comes from recurring review points: keeping the format of existing backups unchanged, skipping rather than saving wrong data, failing early in
parse_args, and tests sized to the change. Two items came from looking at theAGENTS.mdfiles of comparable projects: write for readers who weren't in the agent's session, and check for an open pull request before starting a competing one.AGENTS.mdis read natively by Codex, Cursor and GitHub Copilot, and by Claude Code when there is noCLAUDE.md, so a single file covers the common tools.Also in this PR:
README.rstpoints toAGENTS.md.--ignore=E501,E203,W503).