HBASE-30173 Add AGENTS.md for LLM-assisted codebase navigation#8269
Open
ndimiduk wants to merge 2 commits into
Open
HBASE-30173 Add AGENTS.md for LLM-assisted codebase navigation#8269ndimiduk wants to merge 2 commits into
ndimiduk wants to merge 2 commits into
Conversation
LLM-based tools (code assistants, security scanners, review agents) increasingly operate against large codebases. This adds an AGENTS.md convention file that teaches these tools how to navigate HBase's 37+ Maven modules, understand the client/server divide, use existing @InterfaceAudience annotations for orientation, and locate key entry points. The security model section points to the existing documentation rather than duplicating it. Also adds a dev-support/README.md index and fixes stale content across 12 existing READMEs — incorrect paths, removed modules, outdated versions, broken URLs, and a complete rewrite of hbase-endpoint and hbase-rest READMEs that described code no longer present. Three Java comment references to the renamed hbase-hadoop2-compat module were corrected as well. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
liuxiaocs7
approved these changes
May 23, 2026
- Clarify coprocessor interface locations (observers in hbase-server, not hbase-client) - Add hbase-extensions module to AGENTS.md - Note ghost directories from removed modules - Remove stale protobuf/server/coprocessor/example reference - Fix VirtualBox link and typo in release-vm README Co-Authored-By: mimo-v2.5-pro <mimo@xiaomi.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
2 participants
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.
LLM-based tools (code assistants, security scanners, review agents) increasingly operate against large codebases. This adds an AGENTS.md convention file that teaches these tools how to navigate HBase's 37+ Maven modules, understand the client/server divide, use existing @InterfaceAudience annotations for orientation, and locate key entry points. The security model section points to the existing documentation rather than duplicating it.
Also adds a dev-support/README.md index and fixes stale content across 12 existing READMEs — incorrect paths, removed modules, outdated versions, broken URLs, and a complete rewrite of hbase-endpoint and hbase-rest READMEs that described code no longer present. Three Java comment references to the renamed hbase-hadoop2-compat module were corrected as well.