返回
提交信息指南:遵循最佳实践,井井有条
前端
2023-10-11 03:29:30
提交信息指南
- 明确的目的 :提交信息应该清楚地表明这次提交的目的和所做的改动。使用动词开头,如“修复”、“添加”、“删除”等。
- 简短而有意义 :提交信息应该简短而有意义,避免长篇大论。一般来说,一行即可,最多不要超过三行。
- 使用现在时态 :提交信息应该使用现在时态,而不是过去时态或将来时态。
- 引用相关问题或工单 :如果这次提交是为了修复某个问题或完成某个工单,请在提交信息中引用相关的问题或工单编号。
- 使用换行符 :使用换行符可以使提交信息更易读,特别是在提交信息较长时。
- 避免使用特殊字符 :避免在提交信息中使用特殊字符,如制表符、换页符等。这些字符可能会导致提交信息在某些情况下无法正确显示。
工具的使用
- commitizen :这是一个命令行工具,可以帮助开发人员根据提交信息规范生成提交信息。commitizen 使用一系列交互式的问题来引导开发人员编写提交信息。
- commitlint :这是一个 JavaScript 库,可以帮助开发人员验证提交信息是否符合提交信息规范。commitlint 可以作为 git hook 使用,在提交信息不符合规范时阻止提交。
直接抄走的配置
commitizen:
path: ./node_modules/cz-customizable
commitlint:
extends: [cz]
rules:
- type-enum:
- allowedTypes: [feat, fix, chore, refactor, docs, style, test, build, ci, revert]
- type-case: [error, always, lower-case]
- scope-enum: [error, always, never]
- body-leading-blank: [error, always]
- body-max-length: [error, always, 100]
- subject-full-stop: [error, never]
- subject-case: [error, always, lower-case]
- footer-max-length: [error, always, 1000]
git cz 的原理
git cz 是一个命令行工具,可以帮助开发人员使用 commitizen 生成提交信息。git cz 的原理是,它首先在当前目录下创建一个名为.czrc的文件,该文件包含 commitizen 的配置信息。然后,git cz 会根据.czrc文件中的配置信息生成提交信息。
遵循规范,提高质量
规范提交信息不仅可以提高代码的可追溯性,还可以让团队成员更容易理解和审查代码改动。使用 commitizen 或 commitlint 等工具可以帮助开发人员轻松地编写规范的提交信息。遵循提交信息规范是提高代码质量和协作效率的重要一步。