Add AGENTS.md#19084
Conversation
|
This is the one I use: https://gist.github.com/gianm/031a578a75b4dc44f3e45661d86bcca9 It focuses on the module structure, code style, & Maven commands for running tests, because those were the things I had seen agents having the most trouble with. |
|
I like Gian's as a reference place to start! In addition to that, I think some thing brief about how to build and test the web-console + generate snapshots would also be useful as that is a bit of a pain point for folks who may once a year have to make a UI change and would be nice if an agent could easily handle. |
Use https://gist.github.com/gianm/031a578a75b4dc44f3e45661d86bcca9 as a base and add some more instructions.
Thanks, this seems useful. I've updated it to use this as the base template with a few tweaks:
|
3 participants
Add
AGENTS.mdthat AI tools like Claude and Cursor can leverage. The general recommendation from these tools is to keep the markdown files lightweight but collaborative, so most folks using these tools in the repo for development or otherwise can use it right out of the box.Other Apache repos like Spark and Superset follow a similar structure as well.
Use https://gist.github.com/gianm/031a578a75b4dc44f3e45661d86bcca9 as a baseline with some minor tweaks.