Skip to content

Add basic assumptions to AGENTS.md#3552

Open
rambleraptor wants to merge 4 commits into
apache:mainfrom
rambleraptor:agents-md
Open

Add basic assumptions to AGENTS.md#3552
rambleraptor wants to merge 4 commits into
apache:mainfrom
rambleraptor:agents-md

Conversation

@rambleraptor

Copy link
Copy Markdown
Collaborator

Rationale for this change

Our AGENTS.md just talks about the security model. We get a non-trivial amount of AI activity on this repo and our AGENTS.md should reflect some basic assumptions we want for those PRs.

A lot of this was inspired by Iceberg AGENTS.md.

This is just meant to be an initial version with some thoughts that I've seen and some of the basic architecture (as seen in the Iceberg AGENTS.md)

Are these changes tested?

Just Markdown.

Are there any user-facing changes?

No.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
## Testing

- Bias towards adding tests to existing files, rather than creating new files.
- Use existing test fixtures when possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a line on our preference for integration testing over mocking?

@rambleraptor rambleraptor Jul 6, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I mentioned that we should only use mocks if similar tests exist in the codebase. The best place I can think of is in the REST Catalog, but that feels too specific to hardcode in here.

Comment thread AGENTS.md
@Fokko

Fokko commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Thanks @rambleraptor for extending this, I like it a lot!

Co-authored-by: Fokko Driesprong <fokko@apache.org>

@jayceslesar jayceslesar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to add something about comparing to upstream implementations when possible (java)

@jayceslesar

jayceslesar commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

It might be good to add something about looking for existing PRs as well.. it seems recently that there are clearly some automations on "easier" issues where 2-3 PRs pop up and it makes it difficult to pick one to review hahahahah, additionally this is good to build of work someone may have done previously and adhere to guidelines about preserving that work! I am literate now and I see that is there lol

@rambleraptor

Copy link
Copy Markdown
Collaborator Author

Just pushed up the changes! Thanks for your patience. I've had some OOO time lately.

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.

4 participants