一、代码检查
你的提交合并请求会触发合并检查相关的 Github Actions 包括格式化、文档、验收测试等基本检查,当这些检查通过,我们会主动 Review 你的代码,给出反馈或者直接合入。在分支推送到远端之前你也可以在本地执行这些步骤。
二、设置提交钩子
本地仓库下目录执行 make hooks ,该命令会安装格式化检查的相关依赖,以及将 pre-commit.sh 添加到提交钩子中。
三、代码格式化
可以主动执行 make fmt 格式化 go 代码和 import 顺序。
四、文档同步
执行 make doc ,只要你在代码中更改文档相关的内容,./gendoc 脚本就能解析并将改动同步到 ./website 下。
五、编写验收测试
要确保你的变更能如期工作,你需要编写验收测试用例,或者在已有的用例中添加参数断言,以 cover 你的变更。详情请参见 编写测试用例。测试付费资源会真实地发起计费流程,你也可以先写好测试用例,之后由我们来运行你的测试用例。