返回
代码提交格式化以及 commit 信息规范
前端
2023-12-11 03:28:49
在软件开发中,代码提交和 commit 信息是至关重要的。统一的代码提交格式和规范的 commit 信息可以帮助团队保持代码库的整洁有序,并 облегчить collaborazione。
本文将介绍一种有效的方法来规范团队的代码提交格式和 commit 信息。这种方法使用了一个简单易用的轮子,可以自动执行格式化和验证任务。
使用轮子规范代码提交和 commit 信息
我们使用的轮子名为 "commitlint"。这是一个流行的 JavaScript 库,可以帮助 enforce 提交消息的约定。
要使用 commitlint,需要遵循以下步骤:
- 安装 commitlint: 使用 npm 或 yarn 安装 commitlint。
npm install --dev commitlint
- 创建 commitlint 配置文件: 在项目根目录创建一个名为 ".commitlintrc.json" 的文件,并添加以下内容:
{
"extends": ["@commitlint/config-conventional"]
}
- 集成到 git: 将以下内容添加到项目根目录的 ".git/hooks/pre-commit" 文件中:
#!/bin/sh
npx commitlint --edit $1
- 提交更改: 提交上述更改。
规范代码提交格式
commitlint 使用 Conventional Commits 规范来验证提交消息的格式。此规范要求提交消息具有以下结构:
<type>(<scope>):