Skip to content

Update AGENTS.md#14

Merged
AdheipSingh merged 1 commit intoapache:masterfrom
razinbouzar:agents-optimization
Apr 13, 2026
Merged

Update AGENTS.md#14
AdheipSingh merged 1 commit intoapache:masterfrom
razinbouzar:agents-optimization

Conversation

@razinbouzar
Copy link
Copy Markdown
Contributor

AGENTS.md is now a shorter operational guide instead of a broad contributor doc. It keeps the important repo map, replaces the old “all files need headers” rule with guidance based on make rat, centralizes generated-file ownership under a new “Generated Artifacts” section, and clarifies that make docker-build is a full verification-plus-build target rather than a cheap smoke test.

I also tightened the PR guidance so it matches .github/pull_request_template.md, including the requirement to add comments explaining the “why” when intent is not obvious, and trimmed the pitfalls list down to the mistakes most likely to confuse an agent.

Fixes #XXXX.

Description


This PR has:

  • been tested on a real K8S cluster to ensure creation of a brand new Druid cluster works.
  • been tested for backward compatibility on a real K*S cluster by applying the changes introduced here on an existing Druid cluster. If there are any backward incompatible changes then they have been noted in the PR description.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Key changed/added files in this PR
  • MyFoo
  • OurBar
  • TheirBaz

@razinbouzar
Copy link
Copy Markdown
Contributor Author

@AdheipSingh or @abhishekrb19 can either of you review this? It's a concatenated version of the file in keeping with best practices.

@AdheipSingh AdheipSingh merged commit 1075589 into apache:master Apr 13, 2026
2 checks passed
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.

2 participants