Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
244 lines (175 loc) · 4.85 KB

CONTRIBUTING.md

File metadata and controls

244 lines (175 loc) · 4.85 KB

贡献指南

感谢您对本项目的关注！我们欢迎任何形式的贡献，包括但不限于：

  • 报告 Bug
  • 提交新功能建议
  • 改进文档
  • 提交代码修复或新功能

🚀 快速开始

1. Fork 本仓库

点击右上角的 "Fork" 按钮，将本仓库 Fork 到您的 GitHub 账户。

2. 克隆仓库

git clone https://github.com/YOUR_USERNAME/qwen3_test.git
cd qwen3_test

3. 创建分支

git checkout -b feature/your-feature-name

分支命名建议：

  • feature/xxx - 新功能
  • fix/xxx - Bug 修复
  • docs/xxx - 文档更新
  • refactor/xxx - 代码重构

4. 配置开发环境

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

# 安装依赖
pip install -r requirements.txt

📝 提交规范

Commit Message 格式

使用清晰的 commit message，建议遵循以下格式：

<type>(<scope>): <subject>

<body>

<footer>

Type 类型：

  • feat: 新功能
  • fix: Bug 修复
  • docs: 文档更新
  • style: 代码格式调整（不影响功能）
  • refactor: 代码重构
  • test: 测试相关
  • chore: 构建过程或辅助工具的变动

示例：

feat(training): 添加支持多 GPU 训练

- 实现分布式训练逻辑
- 更新配置文件参数
- 添加相关文档

Closes #123

代码规范

  • 遵循 PEP 8 Python 代码规范
  • 使用有意义的变量和函数名
  • 添加必要的注释和文档字符串
  • 保持代码简洁易读

推荐使用代码格式化工具：

# 安装 black 和 flake8
pip install black flake8

# 格式化代码
black .

# 检查代码风格
flake8 .

🐛 报告 Bug

如果您发现了 Bug，请通过 GitHub Issues 提交，并包含以下信息：

  1. Bug 描述：清晰简洁的描述问题
  2. 重现步骤：详细的重现步骤
  3. 期望行为：您期望发生的行为
  4. 实际行为：实际发生的行为
  5. 环境信息：
    • 操作系统版本
    • Python 版本
    • MLX 版本
    • Apple 芯片型号
  6. 截图或日志：如果可能，提供相关截图或错误日志

Bug 报告模板：

## Bug 描述
简要描述这个 Bug

## 重现步骤
1. 执行 '...'
2. 看到 '...'
3. 发生错误 '...'

## 期望行为
描述您期望发生的行为

## 实际行为
描述实际发生的行为

## 环境信息
- OS: [例如 macOS 14.0]
- Python: [例如 3.10.0]
- MLX: [例如 0.4.0]
- 芯片: [例如 M1 Pro 32GB]

## 附加信息
添加任何其他有用的信息、截图或日志

💡 功能建议

如果您有新功能的想法，欢迎通过 GitHub Issues 提交功能请求：

  1. 功能描述：详细描述新功能
  2. 使用场景：说明该功能的应用场景
  3. 预期效果：描述实现后的预期效果
  4. 替代方案：如果有，列出可能的替代方案

📖 文档贡献

文档改进也是非常重要的贡献！

  • 修复文档中的错误
  • 改进文档的清晰度
  • 添加示例和教程
  • 翻译文档

🔍 代码审查

所有的 Pull Request 都需要经过代码审查。审查者会关注：

  • 代码质量和可读性
  • 是否符合项目规范
  • 是否有充分的测试
  • 文档是否完善

✅ Pull Request 流程

  1. 确保您的代码通过所有测试

    # 运行测试（如果有）
python -m pytest

  2. 更新文档

    • 如果添加了新功能，更新 README.md
    • 添加或更新代码注释
    • 更新 CHANGELOG.md（如果有）

  3. 提交 Pull Request

    • 填写 PR 模板
    • 清晰描述您的更改
    • 关联相关的 Issue（如果有）

  4. 响应审查意见

    • 及时回复审查者的评论
    • 根据反馈进行必要的修改

📋 Pull Request 模板

## 更改描述
简要描述这个 PR 做了什么

## 更改类型
- [ ] Bug 修复
- [ ] 新功能
- [ ] 文档更新
- [ ] 性能优化
- [ ] 代码重构

## 相关 Issue
Closes #(issue number)

## 测试
描述您如何测试了这些更改

## 检查清单
- [ ] 代码遵循项目规范
- [ ] 已添加必要的注释
- [ ] 已更新相关文档
- [ ] 已通过所有测试
- [ ] 已添加新的测试（如果适用）

## 截图（如果适用）
添加相关截图

## 附加说明
任何其他需要说明的信息

🤝 行为准则

参与本项目时，请遵守以下准则：

  1. 尊重他人：保持友好和尊重的态度
  2. 建设性反馈：提供有建设性的意见和建议
  3. 包容性：欢迎不同背景和经验水平的贡献者
  4. 专业性：保持专业的沟通方式

📧 联系方式

如有任何问题，可以通过以下方式联系：

🙏 感谢

感谢每一位贡献者对本项目的支持和帮助！您的贡献让这个项目变得更好。

再次感谢您的贡献！ 🎉