参与代码贡献 #

代码提交 #

1. 首先 fork 一份仓库代码到自己的版本库中。
2. 在自己的版本库中新建开发分支,并在该分支上进行代码修改,修改后提交到自己的版本库。
3. 在自己的版本库中创建一个 pull request,源分支选择自己的开发分支,目标分支选择主库的 master 分支。详见 GitHub 帮助文档
4. 提交 pull request 请求,随后等待项目的开发者进行代码审查。如果 pull request 长时间未被审查,可以主动跟进,找到团队成员提出代码审查请求。代码审查通过后,您将成为 SagooIOT 开源项目的正式贡献者。
5. 恭喜您,您的姓名将永久记录在 SagooIOT 开源项目的贡献者名单中。感谢您为项目做出的贡献!

代码协作约定 #

1. 所有源码文件、类型和方法需要有详细的中文注释,方便其他开发者理解。
2. 如果程序中的某些逻辑比较复杂,需要在注释中解释实现思路,以便后续维护。
3. 对于新增的功能或模块,需要编写单元测试,并确保测试用例覆盖率达到80%以上。这样可以确保新增代码的正确性。
4. 提交代码时,注释和测试用例也要包括在内,不仅仅是源码修改。
5. 如果有不清楚的地方,可以在代码注释或文档中特别说明,方便代码审查人员理解。
6. 需要遵守项目的代码规范,保持代码整洁,便于长期维护。