This is an automated email from the ASF dual-hosted git repository.
wwbmmm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/brpc.git
The following commit(s) were added to refs/heads/master by this push:
new 5cdf8218 docs(agents): guide contributors through repository workflows
(#3370)
5cdf8218 is described below
commit 5cdf821838242bc9fa5c7400465546904a475f01
Author: darion-yaphet <[email protected]>
AuthorDate: Sun Jul 5 10:09:39 2026 +0800
docs(agents): guide contributors through repository workflows (#3370)
Replace the minimal agent note with a concise contributor guide tailored to
the brpc repository. The guide captures structure, build and test commands,
coding style, testing expectations, PR guidance, and security reminders.
---
AGENTS.md | 49 ++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 42 insertions(+), 7 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index b0fde766..5da60c1f 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -14,14 +14,49 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Agent Guide for brpc
+# Repository Guidelines
-This file is read by automated agents (security scanners, code
-analyzers, AI assistants) operating on this repository.
+## Project Structure & Module Organization
-## Security
+Core C++ code lives in `src/`: `src/brpc`, `src/bthread`,
+`src/butil`, `src/bvar`, `src/json2pb`, and `src/mcpack2pb`. Tests are in
+`test/` and mirror module names. Samples are in `example/`; utilities
+are in `tools/`. Documentation is under `docs/en` and `docs/cn`; packaging and
+bindings live in `package/`, `homebrew-formula/`, `python/`, and `java/`.
-Security model: [SECURITY.md](./SECURITY.md)
+## Build, Test, and Development Commands
-Agents that scan this repository should consult `SECURITY.md` and the
-threat model it links before reporting issues.
+- `sh config_brpc.sh --headers=/usr/include --libs=/usr/lib && make`:
configure and build with Make.
+- `cmake -B build && cmake --build build -j6`: configure and build with CMake.
+- `cmake -B build -DBUILD_UNIT_TESTS=ON && cmake --build build -j6 && cd build
&& ctest`: run CMake tests.
+- `cd test && make && sh run_tests.sh`: run the Make-based test suite.
+- `bazel build //:brpc` and `bazel test //test/...`: build or test with Bazel.
+- `cd example/echo_c++ && make && ./echo_server & ./echo_client`: smoke-test
an example.
+
+## Coding Style & Naming Conventions
+
+Follow Google C++ style with 4-space indentation. Keep feature-specific code in
+the relevant protocol or module, not broad files such as `server.cpp` or
+`channel.cpp`, unless the behavior is general. Use existing names:
+`*_unittest.cpp` or `*_unittest.cc`, module prefixes such as `brpc_`,
+`bthread_`, and `bvar_`, and `.proto` files beside related code.
+
+## Testing Guidelines
+
+New behavior should include unit tests. Run the smallest relevant test first,
+then the broader affected suite. Tests use Google Test and live in `test/`.
+Some integration tests require Redis or MySQL and may skip when absent.
+
+## Commit & Pull Request Guidelines
+
+Recent history uses short imperative subjects such as `Fix bazel compile error
+on macOS`. Keep commits focused, explain behavioral impact when needed, and
+link issues. Pull requests should describe the change, list tests run, note
+platform or dependency assumptions, and pass GitHub Actions.
+
+## Security & Configuration Tips
+
+Read `SECURITY.md` before reporting vulnerabilities. Avoid committing
+build directories, local paths, credentials, or machine-specific configuration.
+Prefer flags such as `--with-glog`, `--with-thrift`, `--with-asan`,
+or the matching CMake/Bazel options.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
