MindYOLO 贡献指南¶

贡献者许可协议¶

首次向 MindYOLO 社区提交代码前，需签署 CLA。

个人贡献者请参考 ICLA 在线文档了解详细信息。

请遵循此风格，以便 MindYOLO 易于审查、维护和开发。

MindYOLO 社区使用 Python PEP 8 编码风格建议的 Python 编码风格和 Google C++ 编码指南建议的 C++ 编码风格。 CppLint、CppCheck、CMakeLint、CodeSpell、Lizard、ShellCheck 和 PyLint 用于检查代码格式，建议在 IDE 中安装这些插件。

MindYOLO 社区使用 pytest 建议的 Python 单元测试风格和 Googletest Primer 建议的 C++ 单元测试风格。测试用例的设计意图应该通过其注释名称来体现。

我们鼓励开发人员重构我们的代码以消除代码异味。所有代码都应符合编码风格和测试风格的需求，重构代码也不例外。Lizard 对 nloc（无注释的代码行数）的阈值为 100，对 cnc（循环复杂度数）的阈值为 20，当您收到 Lizard 警告时，您必须重构要合并的代码。

我们使用 MarkdownLint 检查 markdown 文档的格式。MindYOLO CI 根据默认配置修改了以下规则。

具体请参见RULES。

在向MindYOLO项目提交代码之前，请确保该项目已经fork到你自己的仓库。这意味着MindYOLO 仓库和你自己的仓库之间会并行开发，所以要小心避免两者不一致。

如果要将代码下载到本地机器，git 是最好的方式：

# 对于 GitHub
git clone https://github.com/{insert_your_forked_repo}/mindyolo.git
git remote add upper https://github.com/mindspore-lab/mindyolo.git

为避免多个分支之间不一致，SUGGESTED 建议签出到新分支：

git checkout -b {new_branch_name} origin/master

以 master 分支为例，MindYOLO 可能会根据需要创建版本分支和下游开发分支，请先修复上游的 bug。然后你可以任意更改代码。

更新代码后，应以正式方式推送更新：

git add .
git status # 检查更新状态
git commit -m "您的提交标题"
git commit -s --amend #添加提交的具体描述
git push origin {new_branch_name}

最后一步，您需要将新分支与 MindYOLO master 分支进行比较。完成拉取请求后，Jenkins CI 将自动设置为构建测试。您的拉取请求应尽快合并到上游主分支中，以降低合并风险。

为项目做出贡献的一种好方法是在遇到问题时发送详细报告。我们始终欣赏写得好、详尽的错误报告，并会为此感谢您！

报告问题时，请参考以下格式：

问题咨询：

PR 建议：