Add setup, checks, and repo layout to AGENTS.md#2520
Open
Zandereins wants to merge 1 commit 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
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.
What
Adds setup, the two CI-enforced checks, and the repo layout to
AGENTS.md.Why
AGENTS.mdis the file coding agents load on startup. Today it holds three style rules and no operational information, so an agent working from it alone doesn't know how to install the package, how to run the tests, or thatmake styleexists — it will hand-format code and open PRs that failmake quality.Everything added is taken from the repo's own sources, not invented:
pip install -e ".[dev]"—CONTRIBUTING.mdmake quality/make style/make test—Makefile, and the same commands run in.github/workflows/quality.ymlandtests.ymlpyproject.tomlandtests.ymlE/F/I/W, isort first-party —[tool.ruff]inpyproject.tomlThe three existing guidelines are kept verbatim; the change is additive.
Note
This PR was authored by an AI agent (Claude Code), disclosing it since the diff is about instructions for agents.
Context: found while running a deterministic quality survey of AGENTS.md files across major agent repos — smolagents scored 50/100, entirely for missing operational content. Happy to share the method if it's useful.