You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brpc.apache.org by "darion-yaphet (via GitHub)" <gi...@apache.org> on 2026/07/04 05:45:46 UTC
[PR] docs(claude): add Claude Code project guidance file (brpc)
darion-yaphet opened a new pull request, #3369:
URL: https://github.com/apache/brpc/pull/3369
### 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:
- [x] 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.)
- [x] Please follow [Contributor Covenant Code of Conduct](https://github.com/apache/brpc/blob/master/CODE_OF_CONDUCT.md).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@brpc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@brpc.apache.org
For additional commands, e-mail: dev-help@brpc.apache.org
Re: [PR] docs(claude): add Claude Code project guidance file (brpc)
Posted by "wwbmmm (via GitHub)" <gi...@apache.org>.
wwbmmm merged PR #3369:
URL: https://github.com/apache/brpc/pull/3369
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@brpc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@brpc.apache.org
For additional commands, e-mail: dev-help@brpc.apache.org