Repository navigation
🤖 Add AGENTS.md for AI coding agents - #220
Merged
Merged
Conversation
Closes jfhbrook#219. Co-authored-by: Cursor <cursoragent@cursor.com>
6 tasks done
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.
Closes #219.
🤖 AI tooling was used for this PR: the file was drafted with an AI coding assistant, then I checked every statement against the repo and ran the commands it tells agents to run. The commit subject carries the 🤖 marker per DEVELOPMENT.md.
What
A single
AGENTS.mdat the repo root, as discussed in the issue. It is the short loop for an agent changing the code and points to DEVELOPMENT.md for contributor rules and publishing instead of copying them. It covers:pyee/defines and which optional libraries it imports.justrecipes for install, format, check (Pyright), mypy, test, and lint, and what each one runs.devgroup).Self = Anyon emitter methods, Black/isort/flake8 settings, the changelog heading format, the 🤖 rule, andCONTRIBUTORS.md.Two things I noticed while checking, which the file mentions rather than fixes:
uploadandupgrade, which the justfile does not have, and omitsmypyandconsole, which it does. AGENTS.md tells agents to trust the justfile.tox.inistill listspy38-py310whilerequires-pythonis>=3.12, so AGENTS.md points agents atjust testinstead ofjust tox.Happy to fix either of those in a separate PR if you want.
Verification
Ran on this branch (Python 3.12, uv):
just format: no changesjust check:0 errors, 0 warnings, 0 informationsjust mypy:Success: no issues found in 16 source filesjust lint: flake8 clean,Valid file: ./pyproject.tomljust test:52 passedNo changelog entry, since the Publishing section has the maintainer write the changelog at release time. I'm already listed in
CONTRIBUTORS.md.