代码提交规范

最新推荐文章于 2024-09-18 17:42:26 发布

鱼柠檬

最新推荐文章于 2024-09-18 17:42:26 发布

阅读量352

点赞数

分类专栏：日常规范

本文链接：https://blog.csdn.net/rbgg_mp/article/details/116003957

版权

日常规范专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文详细介绍了代码提交规范，强调了清晰的Commit Message对于后续代码审查、信息查找及版本回退的重要性。遵循特定的提交格式，如`<type>: <subject>`，类型包括feat、fix、docs等，确保每个提交都有明确的目的描述，不超过50字符。通过示例展示了如何编写有效的Commit Message，以提升团队协作效率。

摘要由CSDN通过智能技术生成

代码提交规范

大量的代码提交，必然会产生大量的 Commit log. 每一条都 Commit log 记录着某一阶段所完成的事以及关注点，应该尽可能详细具体；在工作中一份清晰规范的 Commit Message 能让后续代码审查、信息查找、版本回退都更加高效可靠

提交格式

<type>: <subject> 注意冒号后面有空格。

type
用于说明 commit 的类别，只允许使用下面 7 个标识。
- feat：新功能（feature）
- fix：修补 bug
- docs：文档（documentation）
- style：格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改 bug 的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
  如果 type 为 feat 和 fix，则该 commit 将肯定出现在 Change log 之中。
subject
subject 是 commit 目的的简短描述，不超过 50 个字符，且结尾不加句号（.）。

git commit -m 'feat:添加了一个用户列表页面'

git commit -m 'fix:修复用户列表页面无法显示的bug'

git commit -m 'refactor:用户列表页面代码重构'