docs: add AGENTS.md with contribution rules for AI agents - #15121
Merged
Conversation
Adds a model-neutral AGENTS.md at the repo root summarizing the conventions that most often trip up automated contributors, most importantly that algorithms-keeper closes any PR without a checked box in the 'Describe your change' section. Complements CONTRIBUTING.md.
Member
|
Nice but… This project uses Would it be better to suggest commands like: |
Contributor
Author
|
Good catch — done in e0fbc95. Swapped the |
cclauss
approved these changes
Aug 30, 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
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.
Describe your change:
Adds a model-neutral
AGENTS.mdat the repo root, as suggested by @cclauss in #15119, so AI coding agents (and their humans) have a single place that records the conventions that most often trip up automated PRs.The headline rule is the one that keeps closing bot PRs:
algorithms-keepercloses any PR whose "Describe your change" section has no checked box, so the file tells agents to tick the template before submitting. It also summarizes the ruff / type-hint / doctest / naming / placement requirements and points atCONTRIBUTING.mdas the source of truth (it never overrides it).I used the vendor-neutral
AGENTS.mdfilename (the emerging cross-tool convention) rather than a tool-specific one so every agent picks it up.Checklist: