Developer Guide¶
This guide is intended for contributors who want to develop on the FastQTools project.
Table of Contents¶
- Architecture - High-level architecture overview
- Core Design - Core module design decisions
- Build Guide - Build system and toolchain
- Testing - Testing framework and conventions
- Coding Standards - C++ coding standards
- Local Tooling Strategy - clangd, MCP, and plugin boundaries
- Git Workflow - Branching strategy and commit conventions
- Quality Tools - Linting, formatting, and static analysis
- Benchmark Guide - Performance testing methodology
- DevContainer - Containerized development environment
Quick Start¶
- Read the Architecture to understand the overall structure
- Follow the Build Guide to set up your development environment
- Review the Coding Standards for code style
- Refer to the Testing Strategy for writing tests
Development Workflow¶
1. Sync the current branch → 2. Create a branch if needed → 3. Write code and tests →
4. Run lint/test → 5. Commit → 6. Push
Contributing¶
Please see CONTRIBUTING.md for how to contribute code.