贡献指南¶

感谢你对 DL-Hub 的关注！以下是参与贡献的完整流程。

贡献流程¶

graph LR
    A[Fork 仓库] --> B[创建分支]
    B --> C[编写代码]
    C --> D[运行测试]
    D --> E[提交 PR]

1. Fork 与克隆¶

git clone https://github.com/<your-username>/DL-Hub.git
cd DL-Hub
pip install -r requirements-dev.txt

2. 创建分支¶

git checkout -b feat/your-feature-name

3. 编写代码¶

遵循下面的代码规范编写你的改动。

4. 运行测试¶

make lint      # 代码检查
make format    # 自动格式化
make test      # 运行完整测试套件
make smoke     # 冒烟测试

5. 提交 PR¶

将你的分支推送到 GitHub 并创建 Pull Request，描述改动内容和目的。

代码风格¶

# 一键格式化
make format

# 检查但不修改
make lint

新 Lesson 要求¶

添加新的课程 lesson 时，必须包含以下文件：

代码约定¶

• Python 版本：3.10+
• 类型注解：所有函数签名使用 type annotations
• 注释：最少化注释，代码自文档化优先
• 文档字符串：公开 API 使用 docstring

使用 dlhub/ 脚手架¶

from dlhub.seed import seed_everything
from dlhub.device import auto_device
from dlhub.paths import get_output_dir

# 固定随机种子
seed_everything(42)

# 自动设备选择
device = auto_device()

# 获取输出目录
output_dir = get_output_dir("vision", "lesson_01", run_name="baseline")

Make 命令速查¶