Skip to content

Add CLAUDE.md and update AGENTS.md for AI agent guidance#17853

Merged
xiangfu0 merged 1 commit intoapache:masterfrom
xiangfu0:add-claude-md
Mar 12, 2026
Merged

Add CLAUDE.md and update AGENTS.md for AI agent guidance#17853
xiangfu0 merged 1 commit intoapache:masterfrom
xiangfu0:add-claude-md

Conversation

@xiangfu0
Copy link
Contributor

@xiangfu0 xiangfu0 commented Mar 10, 2026

Summary

  • Add CLAUDE.md with project overview, repo layout, detailed plugin module listing, build commands, code style, coding conventions, pre-commit checks, change guidance, and common gotchas
  • Update AGENTS.md: add Kafka 4.0 module, fix JDK CI versions, add import preference convention, and add pre-commit checks section
  • Address PR review comments: fix MSQ → MSQE abbreviation, add imports-over-qualified-names convention

Test plan

  • Verify CLAUDE.md and AGENTS.md content is accurate and consistent
  • Confirm plugin module listings match the actual repo structure

🤖 Generated with Claude Code

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a CLAUDE.md agent guide for Apache Pinot, mirroring the intent of AGENTS.md but formatted for Claude Code usage to provide quick repo/build/convention context for automated agents.

Changes:

  • Introduces a new top-level CLAUDE.md with project overview, repo layout, build/test commands, and coding conventions.
  • Documents common change guidance and “gotchas” for working in this multi-module Maven repo.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


You can also share your feedback on Copilot code review. Take the survey.

- Add CLAUDE.md with project overview, repo layout, detailed plugin module
  listing, build commands, code style, coding conventions, pre-commit checks,
  change guidance, and common gotchas
- Update AGENTS.md: add Kafka 4.0 module, fix JDK CI versions, add import
  preference convention, and add pre-commit checks section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


You can also share your feedback on Copilot code review. Take the survey.

@xiangfu0 xiangfu0 changed the title Add CLAUDE.md for Claude Code agent assistance Add CLAUDE.md and update AGENTS.md for AI agent guidance Mar 12, 2026
@xiangfu0 xiangfu0 merged commit 6c61dd4 into apache:master Mar 12, 2026
4 checks passed
@xiangfu0 xiangfu0 deleted the add-claude-md branch March 12, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants