Open
Conversation
Contributor
|
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. |
Contributor
|
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. |
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.
Placeholder for
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.
We can discuss and flesh out the additional structure and level of detail to include in this file.