Git提交代码规范

Commit message 的格式

Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。

用commit message最好是能有规范和工具的约束。

每次提交,Commit message 都包括三个部分:header,body 和 footer。

其中,header 是必需的,body 和 footer 可以省略。
不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer> 

Header

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

type

用于说明 commit 的类别,只允许使用下面7个标识。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

如果type为featfix,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

scope

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是$location$browser$compile$rootScopengHrefngClickngView等。

如果你的修改影响了不止一个scope,你可以使用*代替。

subject

subject是 commit 目的的简短描述,不超过50个字符。

其他注意事项:

  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号(.)

Body

Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。

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

  

有两个注意点:

  • 使用第一人称现在时,比如使用change而不是changed或changes。
  • 永远别忘了第2行是空行
  • 应该说明代码变动的动机,以及与以前行为的对比。

Footer

Footer 部分只用于以下两种情况:

不兼容变动

如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: ‘attribute‘,
    }

    After:

    scope: {
      myAttr: ‘@‘,
    }

    The removed `inject` wasn‘t generaly useful for directives so there should be no code using it.

  

关闭 Issue

如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。

Closes #234

  

Revert

还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): add ‘graphiteWidth‘ option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

  

Body部分的格式是固定的,必须写成This reverts commit &lt;hash>.,

其中的hash是被撤销 commit 的 SHA 标识符。

如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,

那么它们都不会出现在 Change log 里面。

如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面。

 
时间: 2024-10-11 10:31:46

Git提交代码规范的相关文章

git提交代码至远程仓库

代码提交 代码提交一般有五个步骤: 1.查看目前代码的修改状态 2.查看代码修改内容 3.暂存需要提交的文件 4.提交已暂存的文件 5.同步到服务器 1.     查看目前代码的修改状态 提交代码之前,首先应该检查目前所做的修改,运行git status命令 a)        已暂存 (changes to be committed) new file //表示新建文件 modified //表示修改文件 deleted //表示删除文件 b)       已修改 (changed but n

怎样解决git提交代码冲突

当我们使用git提交代码时,别人可能也同一时候改动了我们改动的文件,可是别人的先合入到配置库里边,这样当我们的提交要合入时.就会产生冲突,能够使用下面步骤来解决冲突: (1) git rebase    分支名称   本地分支名称 (2)rebase之后,就会显示冲突.到目标文件进行改动 (3)git add . (4)git rebase --continue (5) git rebase 分支名称   本地分支名称 (6)repo sync (7)repo upload 如此之后,就可以提交

如何解决git提交代码冲突

当我们使用git提交代码时,别人可能也同时修改了我们修改的文件,但是别人的先合入到配置库里边,这样当我们的提交要合入时,就会产生冲突,可以使用以下步骤来解决冲突: (1) git rebase    分支名称   本地分支名称 (2)rebase之后,就会显示冲突,到目标文件进行修改 (3)git add . (4)git rebase --continue (5) git rebase 分支名称   本地分支名称 (6)repo sync (7)repo upload 如此之后,即可提交代码

git提交代码出现错误fatal: Unable to create &#39;项目路径/.git/index.lock&#39;: File exists.

git提交代码出现错误fatal: Unable to create '项目路径/.git/index.lock': File exists. 具体出错代码如下: 具体原因不详,在stackoverflow上查找了很久,也不清楚原因,但是stackoverflow给出了解决的方法. 解决方法: 在当前项目下打开git bash,运行如下命令: rm -f ./.Git/index.lock 只为成功找方法.大胆的尝试,下一个fun就是你的fun! git提交代码出现错误fatal: Unable

Git提交代码到主分区

git 提交代码,本地新建一个my分支,不从本地master分支直接上传,而是先从本地my分支上提交至本地master分支,然后本地master提交至远程master分支上.前提是远程只有一个master分支.第一步:首先到工程目录下.打开git bash命令框第二步:创建本地my分支,git checkout -b my(已经存在my分支则git checkout my直接切换到my分支)第三步:将本地my的分支上的修改提交至缓存区,        git add .(提交全部修改),或者只修

Git提交代码和更新代码命令

微信公众号:非科班的科班关注可了解更多的java教程和其它资源视频.问题或建议,请公众号留言; 1.Git提交代码 利用命令提交代码的步骤:1.1.拉取服务器代码,避免覆盖他人的代码 git pull 1.2.查看当前项目中有哪些文件被修改 git status 具体状态如下: Untracked:为跟踪,一般为新增文件,此文件在文件夹中,但是没有添加到git库,不参与版本控制,通过git add状态变为Staged Modified:文件已经修改,仅仅是修改,没有做其他的操作 deleted:

如何使用git提交代码

如何使用Git管理代码 Git 是开发人员用来向代码库(msstash)中提交代码或者下载远端代码库中代码的工具. 如何使用git向代码库中提交我们修改后的代码呢? 1.如果是第一次使用git,那么需要在本地电脑上初始化一个代码仓库 cd定位到目录,然后执行 git init, 初始化代码仓库,创建了一个主分支master 如果已经初始化过代码库,那么需要将远程的代码库中的代码copy下来. git clone "https://msstash.morningstar.com/XXXX"

Android Studio如何使用Git提交代码到GitHub和OsChina并解决冲突

由于本人喜爱Git,那就介绍Git,,如何和在GitHub和Oschina拉取和提交项目,并且你会学会如何解决冲突问题!!博主还是那个图片控!! 准备工作 git下载地址:Git下载 oschina注册地址:Oschina github注册地址:GitHub 1. 下载git软件 2. 注册GitHub账号和Oschina账号 3. 完成后如图1.1 和图1.2 图1.1 Git配置成功标志 图1.2 GitHub与本地AS关联成功 进行到此,才能进行下面的操作,中间我忽略了很多,那些确实很基础

eclipse git提交代码

1.安装git 2.安装好后,进行,一个简单配置,填入我们的用户名和邮箱 >>Preferences>Team>Git>Configuration 3.登陆git新建仓库 然后记下ssh地址: 4.创建项目和本地git仓库 打开eclipse,随便创建一个项目,然后 依次:File > Team > Share Project 选择GIT>next 5.提交代码到本地仓库(代码需要先提交到本地仓库后,才能提交到远程git仓库) 首先需要提交代码到本地仓库: