# 附录 E: 贡献指南

欢迎为 SimKit 项目做出贡献！

## 如何贡献

### 1. Fork 仓库

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

### 2. 创建分支

```bash
git checkout -b feature/your-feature-name
```

### 3. 进行更改

- 编写代码
- 添加测试
- 更新文档

### 4. 运行测试

```bash
uv run python -m pytest test/
```

### 5. 提交更改

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

### 6. 推送并创建 Pull Request

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

---

## 代码风格

### 格式化

使用 Ruff 格式化代码：
```bash
uv run ruff format .
```

### Lint

```bash
uv run ruff check .
```

### 提交信息格式

```
<type>: <description>

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

---

## 文档贡献

### 更新文档

1. 在对应的 `.md` 文件中修改
2. 运行 `uv run sphinx-build -b html docs-src docs-build`
3. 检查生成的 HTML

### 添加新页面

1. 在 `docs-src/` 创建新文件
2. 在 `index.md` 的 toctree 中添加
3. 构建并验证

---

## 审查流程

1. CI 检查 (测试 + Lint)
2. 维护者审查
3. 合并到主分支

---

## 许可证

贡献即表示你同意你的贡献采用项目的许可证 (见 [附录 F](appendix-f-license.md))。