📋 提交规范#
本部分面向维护者。普通贡献者无需关注提交信息规范,因为PR在合并前会进行压缩合并。
✍️ 提交格式#
我们采用约定式提交(Conventional Commits)规范,包含表情符号标识变更类型,格式如下:
<type>[(<scope>)]: <message>
重大变更需在类型/作用域后添加!标识
🗂️ 提交类型#
|
新增功能或重大功能改进 |
|
修复缺陷或错误行为 |
|
优化代码性能 |
|
重构代码但不改变外部行为 |
|
调整代码格式(如缩进、空格)不影响逻辑 |
|
更新或改进项目文档 |
|
新增测试或更新现有测试 |
|
更新构建脚本或编译系统 |
|
更新持续集成流程或脚本 |
|
日常维护(版本号更新、元数据调整、资源维护) |
🎯 作用域规范#
可通过**作用域(scope)**指定变更影响的模块。示例:
📝 docs(bs.block): update get_block output
⚠️ 重大变更#
若变更导致不兼容修改,应在类型/作用域后添加!标识。示例:
✨ feat(bs.block)!: add a new macro argument to the replace_type function
此规范确保使用者能及时识别可能影响兼容性的变更。