Skip to content

Placeholder for AGENTS.md#19084

Open
abhishekrb19 wants to merge 1 commit intoapache:masterfrom
abhishekrb19:agents_md
Open

Placeholder for AGENTS.md#19084
abhishekrb19 wants to merge 1 commit intoapache:masterfrom
abhishekrb19:agents_md

Conversation

@abhishekrb19
Copy link
Contributor

@abhishekrb19 abhishekrb19 commented Mar 4, 2026

Placeholder for AGENTS.md that 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.

We can discuss and flesh out the additional structure and level of detail to include in this file.

@gianm
Copy link
Contributor

gianm commented Mar 4, 2026

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.

@capistrant
Copy link
Contributor

capistrant commented Mar 5, 2026

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants