24. 附录 E: 贡献指南

欢迎为 SimKit 项目做出贡献！

24.1. 如何贡献

24.1.1. 1. Fork 仓库

# 在 GitHub 上 Fork 仓库
# 然后克隆到本地
git clone <your-fork-url>
cd simkit

24.1.2. 2. 创建分支

git checkout -b feature/your-feature-name

24.1.3. 3. 进行更改

• 编写代码

• 添加测试

• 更新文档

24.1.4. 4. 运行测试

uv run python -m pytest test/

24.1.5. 5. 提交更改

git add .
git commit -m "feat: add your feature description"

24.1.6. 6. 推送并创建 Pull Request

git push origin feature/your-feature-name
# 然后在 GitHub 上创建 Pull Request

---

24.2. 代码风格

24.2.1. 格式化

使用 Ruff 格式化代码：

uv run ruff format .

24.2.2. Lint

uv run ruff check .

24.2.3. 提交信息格式

<type>: <description>

types:
- feat: 新功能
- fix: Bug 修复
- docs: 文档更新
- style: 代码风格
- refactor: 重构
- test: 测试
- chore: 构建/工具

---

24.3. 文档贡献

24.3.1. 更新文档

1. 在对应的 .md 文件中修改

2. 运行 uv run sphinx-build -b html docs-src docs-build

3. 检查生成的 HTML

24.3.2. 添加新页面

1. 在 docs-src/ 创建新文件

2. 在 index.md 的 toctree 中添加

3. 构建并验证

---

24.4. 审查流程

1. CI 检查 (测试 + Lint)

2. 维护者审查

3. 合并到主分支

---

24.5. 许可证

贡献即表示你同意你的贡献采用项目的许可证 (见 附录 F)。