开发者指南¶

欢迎参与 AxiomRL 的开发！本指南面向希望为项目贡献代码、修复缺陷或扩展功能的开发者。

快速导航¶

只需两步即可启动本地开发：

# 1. 以可编辑模式安装，包含所有开发依赖
pip install -e ".[dev]"

# 2. 安装 Git 预提交钩子
pre-commit install

推荐使用虚拟环境

建议在 venv 或 conda 环境中进行开发，以避免依赖冲突：

python -m venv .venv
source .venv/bin/activate  # Linux/macOS
pip install -e ".[dev]"
pre-commit install

AxiomRL 使用 Makefile 统一管理开发命令，日常开发遵循以下流程：

graph LR
    A[编写代码] --> B[make lint]
    B --> C[make typecheck]
    C --> D[make test-fast]
    D --> E[make verify]
    E --> F[提交 PR]

提交前请运行 make verify

make verify 会依次执行 lint、typecheck、test-fast、test-integration、test-smoke 和 build，确保你的变更通过所有质量关卡。

AxiomRL 采用三层架构，不同层级对代码质量和审查力度有不同要求：