[ZEPPELIN-6405] Add AGENTS.md for AI coding agent guidance#5187
Draft
jongyoul wants to merge 4 commits intoapache:masterfrom
Draft
[ZEPPELIN-6405] Add AGENTS.md for AI coding agent guidance#5187jongyoul wants to merge 4 commits intoapache:masterfrom
jongyoul wants to merge 4 commits intoapache:masterfrom
Conversation
Add comprehensive AGENTS.md following the open standard to help AI coding agents understand and work effectively with the Zeppelin codebase. Includes module architecture, server-interpreter Thrift IPC communication details, plugin system with custom classloading, reflection patterns, interpreter lifecycle, and contributing guide. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… exclusion Add the standard ASF license header to AGENTS.md instead of excluding it from the RAT license check. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…s, and config map; add AI agent dirs to .gitignore AGENTS.md additions: - Build Gotchas: shaded JAR rebuild chain, module build order - Configuration Files: conf/ file roles and template relationship - Module Boundaries: where new code should go - Thrift Code Generation: genthrift.sh workflow, generated files in git - REST API Pattern: AbstractRestApi, JsonResponse, @ZeppelinApi conventions .gitignore additions: - AI coding agent personal config directories (CLAUDE.md, GEMINI.md, .claude/, .gemini/, .codex/, .cursor/, .windsurf/, .cline/, .continue/, .aider*, .augment/, .amazonq/, .junie/, .goose/, .roo/) - AGENTS.md remains shared and tracked in git Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
AGENTS.mdfollowing the open standard to help AI coding agents understand and work effectively with the Zeppelin codebaseTest plan
AGENTS.mdrenders correctly on GitHub./mvnw clean org.apache.rat:apache-rat-plugin:check -Prat)