Conventional Commits 是一种在软件开发中广泛应用的提交信息规范,旨在通过一种标准化的格式来描述每次提交的内容。这种规范有助于开发者创建清晰的提交历史,便于团队协作和版本控制。Conventional Commits 的结构通常包括三个部分:Header、Body 和 Footer。

Header 部分包含三个字段:type(必需)、scope(可选)和 subject(必需)。其中,type 字段用于说明 commit 的类别,如 feat(新增功能)、fix(修复bug)、docs(文档)、style(代码样式)、refactor(重构)、perf(性能优化)、test(测试用例)、chore(其他工作)、build(构建系统)、ci(持续集成流程)等。scope 字段用于说明 commit 影响的范围,而 subject 是对 commit 目的简短描述,不超过 50 个字符。

Body 部分是对本次 commit 的详细描述,可以分成多行,使用第一人称现在时,并说明代码变动的动机以及与以前行为的对比。

Footer 部分可以编写一行或多行脚注,通常用于描述不兼容变动和关闭 Issue。

此外,如果 commit 用于撤销以前的 commit,则必须以 revert: 开头,后面跟着被撤销 Commit 的 Header。

遵循 Conventional Commits 规范,可以使得提交信息更加清晰、一致,便于维护和理解项目的历史变更。这有助于提高团队的开发效率和项目的可维护性。

标签: none

评论已关闭