前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >git:git commit 书写格式

git:git commit 书写格式

作者头像
JNingWei
发布2018-09-28 16:06:14
2K0
发布2018-09-28 16:06:14
举报
文章被收录于专栏:JNing的专栏

git commit 的来源 & 如何使用

  正如 git add 的作用是将文件放入暂存区, git commit 的作用是将修改提交到分支上。

  如果只写一句话,那么以下指令即可:

代码语言:javascript
复制
git commit -m 'Hello Commit !'

  如果想写一整段话,那么输入以下指令,可跳转到文本编辑器界面大书特书:

代码语言:javascript
复制
git commit

  目前,社区有多种 Commit message 的写法规范。经过查阅和比较,我自己采用的是 Angular 规范,这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。


Angular 规范

代码语言:javascript
复制
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

代码语言:javascript
复制
标题行:50个字符以内,描述主要变更内容

主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括: 
    - 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
    - 他如何解决这个问题? 具体描述解决问题的步骤
    - 是否存在副作用、风险? 

尾部:如果需要的化可以添加一个链接到issue地址或者其它文档,或者关闭某个issue。

参数说明

Header部分

  一行,三个字段。type(必需)、scope(可选)和subject(必需)。

  1. type: 代表某次提交的类型,比如是修复一个bug还是增加一个新的feature。 type类型 Annotation feat 新功能(feature) fix 修补bug docs 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等 style 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑 refactor 代码重构,没有加新功能或者修复bug test 测试用例,包括单元测试、集成测试等 chore 改变构建流程、或者增加依赖库、工具等 revert 回滚到上一个版本
  2. scope: 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
  3. subject: 是 commit 目的的简短描述,不超过50个字符。

Body部分

  是对本次 commit 的详细描述,可以分成多行。

  范例:

代码语言:javascript
复制
More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent
  1. 使用第一人称现在时,比如使用change而不是changed或changes。
  2. 应该说明代码变动的动机,以及与以前行为的对比。

Footer部分



Ref:



本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2017年07月04日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • git commit 的来源 & 如何使用
  • Angular 规范
  • 参数说明
    • Header部分
      • Body部分
        • Footer部分
          • Ref:
          领券
          问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档