@ bigcommerce/ validate- 承诺
这是确认承诺信息的一个工具 -- -- 以确保信息格式和所需信息一致.
安装
npm install --save-dev @bigcommerce/validate-commits
使用量
您的承诺信息需要以下格式 :
task(scope): JIRA-1234 My commit message
您还可能想要包含一个消息机构来提供更多信息,例如中断更改.
task(scope): JIRA-1234 My commit message
BREAKING CHANGE: ABC has been renamed to XYZ.
任务
以下列出所支持的任务:
- 功绩: 新特性
- 修补: 错误修正
- 文档: 仅文档更改
- 样式:不影响代码含义的更改(白-空格,格式化,缺少分号等)
- 重设: 代码更改,既不修正错误,也不添加特性
- 每平方英尺: 改进性能的代码更改
- 测试: 添加缺失或更正现有测试
- 杂费: 构建进程或辅助工具和文件生成等库的更改
范围
您需要添加 commit-validation.json 到您的工程的根,以便配置一个支持范围列表。 即:
{
"scopes": [
"payment",
"checkout",
"orders"
]
}
国 际
要在终端运行验证符 :
npx validate-commits
所需资源
- 节点 :
>=22
许可证
麻省理工学院