template/docs/development/README.md

# 开发文档

## 版本信息

- 版本: v1.0.0
- 最后更新: 2025-01-XX
- 维护者: 开发团队

## 开发环境搭建

### 1. 环境要求

- Python 3.8+
- pip
- 虚拟环境工具（venv）

### 2. 安装步骤

```bash
# 创建虚拟环境
python -m venv .venv

# 激活虚拟环境
# Windows
.venv\Scripts\activate
# Linux/Mac
source .venv/bin/activate

# 安装依赖
pip install -r requirements/base.txt
pip install -r requirements/development.txt
```

### 3. 配置环境变量

```bash
# 复制环境变量模板
cp env.example .env

# 编辑.env文件
# 至少需要配置:
# - SECRET_KEY
# - DATABASE_URL
# - FLASK_ENV
```

### 4. 初始化数据库

```bash
# 初始化迁移
flask db init

# 创建初始迁移
flask db migrate -m "Initial migration"

# 应用迁移
flask db upgrade
```

### 5. 运行项目

```bash
python run_dev.py
```

## 代码规范

### 代码风格

- 使用Black进行代码格式化
- 使用isort进行导入排序
- 遵循PEP 8规范

### 代码检查

```bash
# 格式化代码
black src/

# 排序导入
isort src/

# 检查代码
flake8 src/
pylint src/
```

## 测试

### 运行测试

```bash
# 安装测试依赖
pip install -r requirements/test.txt

# 运行所有测试
pytest

# 运行特定测试
pytest tests/test_example.py

# 生成覆盖率报告
pytest --cov=src tests/
```

## 数据库迁移

### 创建迁移

```bash
flask db migrate -m "描述信息"
```

### 应用迁移

```bash
flask db upgrade
```

### 回滚迁移

```bash
flask db downgrade
```

## 变更记录

### v1.0.0 (2025-01-XX)
- 初始版本
- 添加开发环境搭建文档