了解如何为Ultralytics 开源项目做出贡献，并探索与文档、审查 PR 和使用基本工具相关的最佳技巧。
Cookie 设置
点击“接受所有 Cookie”，即表示您同意在您的设备上存储 Cookie，以增强网站导航、分析网站使用情况并协助我们的营销工作。更多信息
了解如何为Ultralytics 开源项目做出贡献，并探索与文档、审查 PR 和使用基本工具相关的最佳技巧。
开源软件的基础是协作、学习和共享。开放源码项目是人们聚集在一起，共同创造比自己更伟大的东西的好方法。在Ultralytics，我们将开源原则牢记于心，并始终鼓励大家为我们的开源项目做出贡献。
如果你很想为Ultralytics贡献自己的一份力量，无论是通过撰写文档、审核代码还是解决问题，但又不知道从何入手，或者遇到了一些问题，我们在这里帮助你入门。在这篇文章中，我们将教你如何开始为Ultralytics 开源项目做贡献。让我们开始吧！
在了解如何做出贡献之前，我们先来回答为什么贡献如此重要。我们坚信Ultralytics 社区贡献的重要性。通过参与我们的开源项目，您所做的不仅仅是帮助我们构建更好的软件。贡献者在确保我们的技术保持开放、协作和不断发展方面发挥着关键作用。您的贡献使我们的项目蓬勃发展、易于访问，并使世界各地的用户和开发人员受益！
除了开发尖端软件，参与Ultralytics 项目也是您成长的绝佳机会。在与经验丰富的开发人员并肩工作的过程中，你可以锻炼自己的编码、解决问题和团队协作能力，而这些开发人员可以为你提供指导并分享最佳实践经验。您的努力可以对全球成千上万人使用的工具产生真正的影响。参与我们的社区活动还可以帮助您扩展专业网络，开拓新的机会，并增强您的投资组合，使您在雇主面前脱颖而出。
.webp)
查看 Ultralytics 官方贡献指南是一个很好的开始。它包含了很多最佳实践和技巧，可以帮助你最大限度地利用你的贡献。第一步是通过了解贡献指南和深入研究代码，熟悉项目中已有的内容。
无论你是想参与开发，还是只想探索最新代码，下一步都需要克隆Ultralytics 软件仓库。克隆完成后，你就可以进入项目目录，在可编辑模式下安装软件包，如下所示。
如果您需要帮助，我们的快速入门指南包含您顺利入门所需的一切。
一旦你建立了自己的环境并熟悉了项目，你就可以探索不同的领域，从而产生有意义的影响。Ultralytics 提供了多种参与方式，你可以根据自己的技能和兴趣选择贡献方式。
以下是一些选项：
每个领域都有独特的贡献方式，您可以选择最符合自己优势和兴趣的领域。请记住，每一份贡献，无论多么微小，都会对Ultralytics 成长和发展起到关键作用。
.webp)
在为Ultralytics 文档撰稿时，请务必查看现有文档，并检查是否有任何问题或讨论突出了需要改进的地方。这样做有助于确保您的贡献集中在最需要的地方。
在编写或编辑时，请记住遵循项目指南以保持一致性是关键。以下是一些格式提示：
.webp)
完成草稿后，务必通过在本地构建文档来预览它。你可以在提交之前发现任何问题。为此，首先克隆存储库并导航到项目目录：
接下来，您可以安装必要的依赖项：
最后，在本地启动文档服务以查看您的更改：
您可以通过在 Web 浏览器中导航到 `http://127.0.0.1:8000/` 来查看本地构建的文档。
在审查清晰度、准确性和一致性之后，您可以提交一个pull request，并清楚地描述您创建的文档。请务必根据文档的归属和最适合的位置（指南、解决方案、集成等）将其放置在适当的部分。另请查看相关部分的index.md文件和整体mkdocs.yml文件，并根据需要进行任何更新。注重细节将有助于审查过程顺利进行，并确保您的贡献能够很好地融入到项目中。
在为Ultralytics 项目贡献代码时，一定要遵循最佳实践，以确保代码整洁、可维护且易于集成。以下是一些需要牢记的要点：
.webp)
此外，还必须考虑代码库的长期可维护性。在进行任何修改之前，先问问自己，你的修改是否会破坏他人使用Ultralytics现有代码。如果会，请考虑如何解决这个问题，并确保您的修改尽可能兼容。
一旦您开发了一段代码，就需要对其进行测试。在提交之前，您可以使用pytest等框架来测试您的修改。代码格式的一致性也是非常重要的一点。Ruff Formatter 等工具可以帮助您保持风格一致，并detect 代码中的任何逻辑错误或不一致之处。
审核拉取请求（PR）是一种很好的贡献方式！当有人要求将自己的修改合并到主项目中时，就会提出拉取请求（PR）。它有助于保持Ultralytics 项目的顺利运行。当你审核一个PR时，请确保你理解为什么要进行修改。作者应该清楚地解释更新的目的和好处，你应该在他们的PR中看到彻底测试的证据。
.webp)
让我们来看看几个需要关注的关键事项。
作为审阅者，请务必提供具体而清晰的反馈，说明任何问题或疑虑。提供改进建议并提出问题，以帮助作者思考潜在的问题。鼓励他们遵循编码、测试和文档方面的最佳实践，并且不要犹豫地向他们指出可以提供帮助的资源。最后但并非最不重要的一点是，始终认可作者为 PR 所做的努力。积极的反馈有助于在开源社区中维持友好和协作的氛围。
为像Ultralytics 这样的开源项目做贡献，能让你感受到令人鼓舞的社区氛围。无论是编写代码、审核 PR、更新文档还是参与讨论，每一份努力都有助于项目的成长和发展。无论是在GitHub、Discord、Subreddit 还是其他论坛上，回答问题或参与对话都是一种宝贵的贡献和与他人沟通的方式。请记住，您的贡献无论多么微小，都会产生重大影响，并有助于为每个人营造一个协作和支持的环境！
在Ultralytics，我们热衷于推动开源社区的创新。访问我们的GitHub 存储库，了解我们的最新动态。加入我们充满活力的社区，了解我们如何在农业和制造业等行业中发挥影响。
