Skip to content

docs(claude): add Claude Code project guidance file#3369

Merged
wwbmmm merged 1 commit into
apache:masterfrom
darion-yaphet:support-claude
Jul 5, 2026
Merged

docs(claude): add Claude Code project guidance file#3369
wwbmmm merged 1 commit into
apache:masterfrom
darion-yaphet:support-claude

Conversation

@darion-yaphet

Copy link
Copy Markdown
Contributor

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:

  • Add CLAUDE.md, covering:
    • bRPC build commands for all three systems (Make/CMake/Bazel) and how to run a single test
    • Core library architecture overview (brpc/bthread/butil/bvar)
    • Key design patterns: protocol plugins, naming services / load balancers, builtin services
    • Google C++ style with the 4-space indentation convention

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:

  • Please make sure your changes are compilable. (Docs only; nothing to compile.)
  • When providing us with a new feature, it is best to add related tests. (Not a feature change; no tests needed.)
  • Please follow Contributor Covenant Code of Conduct.

- 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
@wwbmmm wwbmmm merged commit 3e030aa into apache:master Jul 5, 2026
1 check 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