Link to this section如何贡献 🚀#

欢迎！我们很高兴你考虑为 Ultralytics 的开源项目做出贡献。你的参与有助于提升我们代码库的质量，并造福整个计算机视觉社区。

完整指南

有关全面的贡献指南，请同时查看我们主要文档中的 官方 Ultralytics 贡献指南。

Link to this section观看：为 Ultralytics 做出贡献#

Link to this section快速入门指南 🎯#

准备好贡献了吗？请遵循以下步骤：

1. 阅读我们的 行为准则 - 尊重、友善和专业
2. Fork 你想要贡献的仓库
3. 创建一个具有描述性名称的功能分支
4. 按照编码标准进行更改
5. 为新功能编写测试
6. 提交一个描述清晰的 pull request
7. 通过在 PR 中评论来签署 CLA
8. 回应来自评审者的反馈

请参阅 开发工作流 了解详细的 PR 流程。

Link to this section贡献指南 📋#

Link to this section行为准则 🤝#

所有贡献者必须遵守我们的 行为准则，该准则基于 贡献者公约。这确保了为每个人提供一个欢迎和包容的环境。尊重、友善和专业是我们社区的核心。

Link to this section贡献者许可协议 (CLA) 📝#

在我们合并你的 PR 之前，你必须签署我们的 CLA。这份法律协议确保贡献根据 AGPL-3.0 获得适当许可，从而保护你和项目。

提交 PR 后，CLA 机器人会指引你。要签署，请发表评论：

I have read the CLA Document and I sign the CLA

CLA 涵盖：

• 你贡献的版权和专利许可
• Ultralytics 使用和分发你作品的权利
• 你拥有你贡献权利的声明
• 免责声明

查看完整的 CLA 文档 以了解完整条款。

Link to this section最佳实践 ✨#

贡献代码时：

• 避免重复：尽可能重用现有代码
• 进行更小的更改：专注于小范围修改而非大规模变动
• 简化：寻找简化机会
• 考虑兼容性：避免破坏现有代码
• 使用一致的格式：遵循 Ruff Formatter
• 添加测试：为新功能包含测试
• 更新文档：保持 文档 为最新

Link to this section编码标准 📐#

• 文档字符串：使用带有括号内类型的 Google 风格文档字符串
• 行宽：最大 120 个字符
• 导入：使用 pathlib 而不是 os
• 测试：所有 PR 必须通过 CI 测试
• 类型提示：在有益处的地方使用

请参阅 开发工作流 了解完整的编码标准。

Link to this section贡献方式 🌟#

Link to this section代码贡献 💻#

• YOLO 模型 的新功能和增强功能
• 漏洞修复和问题解决
• 训练 和 推理 的性能优化
• 各种 部署选项 的导出格式支持
• 平台兼容性改进

Link to this section文档 📚#

• 改进现有 文档
• 针对特定用例添加 教程和指南
• 修复拼写错误和错误
• 将文档翻译成其他语言

Link to this section测试 🧪#

• 为新功能编写单元测试
• 在不同的 模型 和 任务 上测试新功能
• 报告测试覆盖率空白
• 跨平台的性能 基准测试

Link to this section社区支持 💬#

• 在 GitHub Discussions 中回答问题
• 在 Discord 上帮助用户
• 评审 pull requests
• 分类问题

Link to this section报告 Bug 🐞#

通过 GitHub Issues 报告错误以帮助我们改进：

Link to this sectionBug 报告要求#

1. 检查现有问题以避免重复
2. 创建 最小可复现示例 (MRE) - 可重现该问题的小型独立代码
3. 描述环境：操作系统、Python 版本、库版本、硬件 (CPU/GPU)
4. 解释预期行为与实际行为，附带错误消息和堆栈跟踪

Link to this section什么构成好的 MRE#

最小可复现示例应该：

• 隔离问题：移除不必要的代码
• 使用公开模型和数据集：例如 yolo26n.pt 和 coco8.yaml
• 包含依赖项：使用 yolo checks 或 pip list 列出
• 提供清晰的描述：预期行为与实际行为
• 正确格式化：使用带有三重反引号的代码块
• 可测试：其他人可以在不修改的情况下运行它

查看完整的 MRE 指南 以获取详细说明。

Link to this section评审 Pull Requests 👀#

评审 PR 是一项有价值的贡献：

• 检查单元测试：验证新功能的测试
• 评审文档：确保文档已更新
• 评估性能：考虑对速度/内存的影响
• 验证 CI 测试：确认所有测试通过
• 提供建设性反馈：具体且有帮助
• 认可努力：感谢贡献者

Link to this section许可信息 📜#

Link to this sectionAGPL-3.0 许可#

Ultralytics 在仓库中使用 AGPL-3.0。这促进了开放、透明和协作改进。

Link to this section在你的项目中使用 YOLO#

如果你在项目中使用 Ultralytics YOLO 模型或代码，AGPL-3.0 要求你的整个衍生作品也必须在 AGPL-3.0 下开源。

合规为何重要：

• 为了社区利益保持软件开放
• 使用 AGPL-3.0 代码时的法律要求
• 促进协作和透明度

替代方案： 如果你不想将项目开源，可以获取 企业许可。

Link to this section如何遵守 AGPL-3.0#

在 AGPL-3.0 下公开完整的源代码：

1. 选择起点：

   • Fork Ultralytics YOLO 仓库
   • 使用 Ultralytics 模板仓库

2. 为你的项目授权：

   • Add LICENSE file with full AGPL-3.0 text
   • 在源代码文件顶部添加许可声明

3. 发布源代码，包括：

   • 完整的应用程序/系统
   • 对 Ultralytics 代码的修改
   • 训练/验证/推理 脚本
   • 如果经过修改，还需包含模型权重
   • 配置文件和所使用的 数据集
   • 后端/前端代码
   • 已修改的第三方库
   • 如果可重新分发，则包含训练数据

4. 清晰记录：

   • 在 README.md 中声明 AGPL-3.0 许可
   • 包含设置说明
   • 适当标注 Ultralytics YOLO

查看 Ultralytics 模板仓库 以获取示例结构。

Link to this section我们的开发团队 👥#

欢迎联系团队成员以获取指导：

Link to this section获取支持 💬#

有问题或需要帮助？

• 在 GitHub 上提交 issue
• 加入 GitHub Discussions
• 通过 Discord 进行联系
• 查看 文档
• 访问 帮助中心
• 浏览 Ultralytics 博客 获取教程和指南
• 探索 解决方案 以了解特定行业的应用

Link to this section感谢你！🎉#

感谢你对参与 Ultralytics 开源项目的兴趣。你的参与对于塑造我们软件的未来以及建立一个充满创新和协作精神的活跃社区至关重要。

我们期待看到你的想法变为现实，并感谢你致力于推动目标检测技术的进步。让我们一起继续成长和创新！🚀🌟

Link to this section资源 📚#

• 官方贡献指南 - 完整的贡献准则
• 开发工作流 - PR 流程和代码标准
• CI/测试 - 测试和质量检查
• 文档工作流 - 编写文档
• 行为准则 - 社区标准
• CLA 文档 - 贡献者许可协议
• MRE 指南 - Bug 报告的最佳实践
• Ultralytics 博客 - 教程和案例研究
• 社区活动 - 网络研讨会和会议
• 客户故事 - 实际应用场景