Add a simple AGENTS.md file - #16124
Conversation
Akuli
left a comment
Akuli
left a comment
There was a problem hiding this comment.
Not a full review, just a few thoughts.
| To run all tests, run: | ||
|
|
||
| ```bash | ||
| python3 -m venv .venv |
There was a problem hiding this comment.
This won't work on Windows, and also linux distros that only ship a python executable.
I don't know whether these commands are more automagical than what users expect their agents to do. For example, what happens if a user has already created a venv with a different name? Will the agent blindly create another one? Maybe someone who uses agents more than I do can comment on that.
There was a problem hiding this comment.
Maybe it's better to just describe what to do ("create a venv", "install requirements using ...", "run runtests") The agents should be able to figure out the correct command for their environment.
| - Follow the guidance from `CONTRIBUTING.md`. | ||
| - Run the tests as described above before submitting. | ||
| - Don't include tests for .pyi files, unless the situation is complex. See | ||
| `tests/REGRESSION.md`. |
There was a problem hiding this comment.
In this file, "See some_file" is prone to get outdated if documentation is refactored. Maybe it's better to leave them out? In my (somewhat little) experience, agents are quite good at finding the thing they are looking for.
There was a problem hiding this comment.
I'm not too concerned about that. The structure hasn't changed that much, and personally I always run a simple search when renaming or moving files to find all occurrences. And I've seen agents miss other instruction files unless given concrete instructions to read them.
2 participants
We get more and more agent-generated PRs. This will hopefully help a bit with agent anti-patterns. Any improvements welcome.