Skip to main content

Navigate the repository

The top-level directories:

src/         library source, headers, and proto files
tests/       test suites and helpers
examples/    runnable sample applications
contrib/     local Conan recipes for deps not on Conan Center
website/     documentation site (this site)

Inside the code:

  • src/braft/ -- the library source. Headers, implementation files, and 8 protobuf definitions all live here. Public headers are in src/braft/*.h (no separate include/ directory yet).
  • tests/public/ -- public-facing tests for the documented braft, storage, wire, and migration contracts.
  • tests/internal/ -- implementation-facing tests where white-box access is still acceptable.
  • tests/legacy/ -- inherited upstream-style regression tests that still give broad coverage but do not define the public spec.
  • tests/support/ -- shared helpers and shims used by the test binaries.
  • examples/counter/, examples/atomic/, examples/block/ -- demo applications. Build them from the repo root with -DBUILD_EXAMPLES=ON.
  • contrib/brpc/ -- local Conan recipe for brpc 1.16.0, which is not available on Conan Center.
  • conanfile.py -- the project's Conan recipe, declaring all dependencies.

For the reasoning behind this layout, see Repository layout.