贡献指南

感谢你考虑为 perfetto-cli 做贡献！

环境搭建

# 克隆仓库
git clone https://github.com/SYKernel/perfetto-cli.git
cd perfetto-cli

# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate

# 以开发模式安装（含开发依赖）
pip install -e ".[dev]"

代码规范

项目使用 ruff 进行代码检查和格式化。

# 检查 lint 错误
ruff check .

# 自动修复 lint 错误
ruff check . --fix

# 检查格式
ruff format --check .

# 自动格式化
ruff format .

运行测试

# 运行全部测试
pytest

# 带覆盖率
pytest --cov=src/perfetto_cli

# 运行特定测试文件
pytest tests/test_sql_helpers.py

# 详细模式
pytest -v

PR 流程

1. Fork 仓库，从 main 创建你的分支
2. 做出修改 — 保持 commit 聚焦和原子化
3. 为新功能添加测试
4. 确保所有测试通过：pytest
5. 确保 lint 通过：ruff check .
6. 提交 PR，附上清晰的变更描述

报告问题

• 使用 Bug 报告 模板反馈 bug
• 使用 功能请求 模板提出新想法

文档开发

# 安装文档依赖
pip install -e ".[docs]"

# 本地预览（支持热重载）
mkdocs serve

# 构建静态站点
mkdocs build