优秀实践辅助团队成功

在团队协作的项目中,良好、一致的提交规范不但更便于向团队清晰准确地说明代码变更、进行代码评审,也便于后期快速定位原始需求或缺陷。

易于执行的清晰规则

X-Developer推荐使用一种简单的提交规范,即在一行文字中说明任务编号、提交类型和提交说明,格式如下(方括号勿需输入):

[#no] [type] [desc]

以下为向任务编号123提交一次功能开发代码(由于 feat 为默认类型,也可不填写):

#123 feat 增加密码重置功能

X-Developer参考业界主流的提交规范(如Google Angular.js项目),提供了一组提交类型定义,供您使用:

提交类型 使用 描述 说明
feat 默认 需求功能 如提交未包含任何类型,则默认为 feat
change 常用 需求变更 非bug修复,而是由于需求变更引起的功能改动
fix 常用 修复bug 如一次提交是bug修复,则必须包含此类型
docs 文档 仅涉及文档编写的提交
style 格式化 仅涉及格式调整的提交,不影响代码运行的变动
refactor 重构 即不是新增功能,也不是修改bug的代码变动
test 增加测试 并未进行功能代码调整
chore 构建脚本 即构建过程或辅助工具的调整

具体执行时,您还可以使用 commitlint 和 husky 来检查开发人员是否执行了提交规范,因X-Developer也可帮助您检查规范执行情况,此处就不再详述。

Icon For Arrow-up