| CARVIEW |
Navigation Menu
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Create an AGENTS.md file
#71796
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create an AGENTS.md file
#71796
Conversation
priethor
added
Developer Experience
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a lot of different ways and changes we can make to this file. I don't think we'll be succeeding in having a perfect file on the first attempt. We should try, fail and iterate here.
I'd love a a few more voices on this PR to have more ideas/opinions but I don't think we should bike shed too much either.
|
I wish claude code supported that already, I wonder if we should add a Claude.md file that says, read the agents.md file :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm willing to give this is a try but would love thoughts from others. I don't think we can be exhaustive here but a small basis to start iterating is good.
youknowriad
requested review from
a team,
ockham and
tellthemachines
and removed request for
a team
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is worth a shot. It's a good start and not overdone. It adds a bit of maintenance burden, but the commands are pretty stable.
|
|
||
| # Development | ||
| npm start # Development with watch | ||
| npm run build # Production build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm run dev too? 🤷🏻
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure dev mode would be useful for an agent; the usual flow is make changes - run build - check if thing built successfully. The constant flow of terminal output in dev mode would be confusing for it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree dev doesn't seem as useful with agents; maybe it should even be discouraged so that the developer has full control of the build process and can:
- Monitor the build output, which is otherwise hidden in a background process.
- Kill the process that runs the watcher more easily.
AGENTS.md
Outdated
| # Setup | ||
| npm install && composer install | ||
| npm run wp-env status # Check if wp-env running | ||
| npm run wp-env start # Start WordPress environment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm run wp-env stop too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have a strong opinion. The idea here is not to teach the available commands to the agent, but to be explicit about checking the status before assuming wp-env is not running and trying to start it. I'll reword this 👍
An alternative that has wider support is adding all this info the the README instead (or in addition to the agents file). AI tends to know about the importance of READMEs in code repos 😄 |
Co-authored-by: priethor <priethor@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: ramonjd <ramonopoly@git.wordpress.org> Co-authored-by: tellthemachines <isabel_brison@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org>
Labels
5 participants
What?
This PR adds an
AGENTS.mdfile with instructions to help AI agents work with this repository.Why?
AI agents are becoming increasingly popular as a supporting development tool. Rather than ignoring this fact, providing guidelines for AI agents will help them be more effective, resulting in a better and faster developer experience with reduced cost and environmental impact.
How?
By following the AGENTS.md format supported by many agents. It's not a formal spec, but a de facto standard, which focuses on:
This first iteration includes dev environment tips, testing instructions, and PR instructions.
Testing Instructions