贡献指南

欢迎来到 HAMi！

行为准则

务必阅读并遵守我们的行为准则

社区期望

HAMi 是一个由社区驱动的项目，致力于促进一个健康、友好和富有成效的环境。

入门

• 在 GitHub 上 fork 这个仓库。
• 在你的 fork 仓库中进行更改。
• 提交一个 PR。

你的第一次贡献

我们将帮助你在不同领域进行贡献，如提交问题、开发功能、修复关键错误以及让你的工作得到审查和合并。

如果你对开发过程有疑问，随时提交一个问题。

找到要处理的内容

我们总是需要帮助，无论是修复文档、报告错误还是编写代码。 查看你认为没有遵循最佳编码实践的地方，需要代码重构或缺少测试的地方。 以下是你如何开始的步骤。

找到一个好的入门主题

在 HAMi 组织内有多个仓库。 每个仓库都有适合初学者的问题，提供一个好的入门问题。 例如，Project-HAMi/HAMi 有 需要帮助和 好的入门问题 标签的问题，这些问题不需要对系统有深入的了解。 我们可以帮助希望处理这些问题的新贡献者。

另一个好的贡献方式是找到文档改进的地方，比如缺失/损坏的链接。 参阅下面的贡献者工作流程以了解工作流程。

处理一个问题

当你愿意承担一个问题时，只需在问题上回复。维护者会将其分配给你。

提交一个问题

虽然我们鼓励每个人贡献代码，但也欢迎有人报告问题。 问题应在相应的 HAMi 子仓库下提交。

示例： HAMi 问题应提交到 Project-HAMi/HAMi。

请在提交问题时遵循提示的提交指南。

贡献者工作流程

不要犹豫提出问题或发送拉取请求。

这是贡献者工作流程的大致概述：

• 创建一个主题分支作为贡献的基础。通常是 master。
• 进行逻辑单元的提交。
• 将更改推送到个人 fork 的仓库的主题分支。
• 提交一个拉取请求到 Project-HAMi/HAMi。

创建拉取请求

拉取请求通常简称为 "PR"。 HAMi 通常遵循标准的github 拉取请求流程。 要提交建议的更改，请开发代码/修复并添加新的测试用例。 之后，在提交拉取请求之前运行这些本地验证，以预测持续集成的通过或失败。

• 运行并通过 make verify

代码审查

为了让你的 PR 更容易获得审查，考虑审查者需要你：

• 遵循良好的编码指南。
• 撰写良好的提交信息。
• 将大的更改分解为一系列逻辑的小补丁，这些补丁单独进行易于理解的更改，并在整体上解决更广泛的问题。