docs(claude): add Claude Code project guidance file#3369
Merged
Conversation
- Document bRPC build commands (Make/CMake/Bazel) and how to run a single test - Outline core library architecture (brpc/bthread/butil/bvar) - Record key design patterns: protocol plugins, naming services, builtin services - Note Google C++ style with 4-space indentation convention
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
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.
What problem does this PR solve?
Issue Number: N/A
Problem Summary:
New contributors and AI coding tools (Claude Code) have no single onboarding
document when getting started with this repo — understanding how to build the
project and how it is structured requires reading through multiple build scripts
and source directories. This PR adds a CLAUDE.md that consolidates that
scattered information into one place.
What is changed and the side effects?
Changed:
Side effects:
Performance effects: None. Documentation-only change; no compiled code is touched.
Breaking backward compatibility: None. Pure documentation addition; no APIs,
build artifacts, or runtime behavior are changed.
Check List: