This file is the entry point for AI coding assistants (Claude Code, Cursor, Codex, etc.) working in this repository. It also applies to human contributors.
The coding rules in docs/CODING_RULES.md apply to all
code changes in this repository, by humans and by AI agents alike.
Before writing or modifying code:
- Read
docs/CODING_RULES.md. - Apply the rules to any new or changed code.
- When reviewing a change (including via
/reviewor/ultrareview), treatdocs/CODING_RULES.mdas the authoritative style and quality baseline.
The rules are not exhaustive — they capture the conventions that matter most for this codebase. Follow the style of surrounding code where the rules don't speak.
The project uses CMake. Supported build environments and setup steps are
documented in docs/build/README.md.
Quick references:
- Requirements and IDE-specific instructions:
README.md. - Cross-platform / WSL build details:
docs/build/README.md.
- Target branch for PRs is
main. - Keep changes focused — one concern per commit (see rule 10 in the coding rules). Smaller diffs review faster.
- Match the style of existing commit messages in
git log. - Reference the related issue in the PR description when applicable.
Don't perform large retroactive cleanups of existing code to fit the rules unless the user explicitly asks for it. Apply the rules going forward; pre-existing code can be refactored opportunistically when you're already touching it.