Development and Contribution

Development and Contribution

Beez is a C++20 application built with CMake, Conan 2, and Clang. This chapter covers how to set up a dev environment, navigate the repository, run tests and quality checks, and land changes.

Contents

• Building and Setup - dependencies, build, install, local run
• Repository Layout - source tree, modules, where to add code
• Testing - unit, integration, system, performance, fuzzer
• Code Quality - format, lint, analysis, security, coverage, sanitizers
• Feature Development Workflow - vertical TDD from user story to make all
• Submitting Changes - PR expectations, CI, definition of done

Quick start

make setup CONAN_PROFILE=conan/profiles/clang-release   # Conan install + CMake configure (Release)
make build          # Compile release binary
make test           # Run all test suites
./build/build/Release/bin/beez --help

Full quality pipeline before opening a PR:

make all

Includes line coverage ≥ 85% on src/. User-visible features require wiki and CHANGELOG.md updates. See Feature Development Workflow and repo docs/README.md.

License

Beez is licensed under Apache-2.0. By contributing, you agree that your contributions are licensed under the same terms.

Related pages

• Project Layout - how end users organize Beez projects (different from this repo layout)
• CLI - CLI behavior contributors may need to extend
• Lua DSL - DSL surface area for plugin work