一、为什么需要代码提交规范

一个好的 Git 提交信息能够使我们:

1.了解贡献者试图做什么
2.自动生成更改日志
3.方便代码回溯

二、提交代码前的检查

为了持续集成,项目提供了必要的基础设施,质量门禁便是其中之一。质量门禁提供了静态代码检查、单元测试、集成测试、测试覆盖率等各项质量检查项,以帮助团队守住质量基线,为持续集成提供必要的基础。
开发每次推送代码至代码库前务必在本地执行质量门禁检查,并且在代码被推送至代码仓库后,构建服务器也会触发质量门禁。
1.静态代码检查

./scripts/check-static

2.提交前检查

./scripts/check-all

3.并行检查

./scripts/check-all-parallel

特别注意:提交代码前一定要运行代码检查命令,否则有可能导致CI异常,所有代码都发布不了

三、提交代码

1.提交信息的模板

[type]: messages

type 取值范围:

build
chore
ci
docs
feat
fix
perf
refactor
revert
release
style
test
improvement

messages: 本次提交代码的中或英文简要描述

注意,该项目是多人协同开发,所以,push 代码前一定要 pull 代码,来保证不会冲掉他人提交的代码。

作者:向海林  创建时间:2023-10-20 15:54
最后编辑:向海林  更新时间:2026-10-22 08:56