ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

git--提交日志规范

2022-08-21 03:02:16  阅读:180  来源: 互联网

标签:变动 git footer -- 规范 提交 commit 日志


对于版本控制工具来说,尤为重要的就是每次提交版本到代码库的日志撰写。清晰、规范、格式化的提交日志有助于追踪版本修改,查看历史记录等。 Git 不允许提交日志为空,这里推荐使用目前使用最广泛的 angular 规范。

angular 规范的 commit message 包括 3 个部分 ,header 、body 和 footer 。

<type> (<scope>) : <subject>//空一行<body>//空一行<footer>

复制

  • type 用于说明 commit 的类型,只允许使用下面 7 个标识
    • feat: 新功能(feature)
    • fix: 修补 Bug
    • docs: 文档 (documention)
    • style: 样式 (不影响代码运行的变动)
    • refactor: 重构 (既不是新增功能,也不是修改 Bug 的代码变动)
    • test: 增加测试
    • chore: 构建过程或辅助工具的变动
  • scope 用于说明 commit 影响的范围,比如数据层、控制层、视图层等,视项目不同而不同
  • subject 是 commit 目的的简短描述,不超过 50 个字符
  • body 部分是对本次 commit 的详细描述,可以分成多行
  • footer 部分只用于两种情况
    • 不兼容变动时,以 BREAKING CHANGE 开头,后面是对变动的描述以及变动理由和迁移方法
    • 如果当前 commit 针对某个 issue ,那么可以在 footer 部分关闭这个 issue

参考地址:https://cloud.tencent.com/developer/article/1404933

标签:变动,git,footer,--,规范,提交,commit,日志
来源: https://www.cnblogs.com/cxy-lxl/p/16609242.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有