`

git commit 原则

    博客分类:
  • git
阅读更多

多人开发时少不了代码review的环节,这时候commit显得尤为重要,

优质的代码提交和简单清晰的common可以让review的人用最短的时间

完成review,以下是我总结的一些commit遇到和需要注意的问题供大家参考。

 

commit是给review的人看的。

review的人具备一定的技术背景;都很忙。

所以commit要尽可能用最少的语言将问题表达清楚。

 

 

一、commit格式,主题 + 内容,中间用行隔开

 

[主题] “这是一个动作,描述做了什么改动,解决哪些问题。”

 

* 长度尽可能短,一句话。

* 能清楚完整的描述本次提交。(不能泛泛而谈,更不能不知所云)

* 动作尽量放在前面,(add、remove、fix、merge、update ...)

 

[内容] “描述问题现象,分析问题原因,阐述解决办法”

 

* 描述复杂的话可以将bugid或issureid的链接贴上

* 内容根据修改的复杂程度酌情填写,主题可以描述清楚的,内容可不写,如添加几个字符串,加几个log什么的

* 如果主题中有多个逻辑修改,这里要每个进行单独描述并分段隔开

 

自定义格式:

 

[fix bug bugid] + 描述

[add feature] + 描述

[fix issue issueid] + 描述

[Merge] + 描述

 

.......

 

二、commit粒度

 

粒度受到产品阶段的影响,不同阶段提交粒度不同,研发阶段可根据功能和框架特征提交。维护阶段细分case后进行提交。但总的原则要保证commit的精简和功能独立。

 

* 维护阶段保证一个问题只做一次commit

* 一次commit对逻辑性文件的修改越少越好

* 多个小case进行一次提交的情况,内容部分对每个case分段描述(不建议)

* merge代码单独做commit。

分享到:
评论

相关推荐

    commit-check:一些git钩子检查提交消息

    它旨在执行博客文章中提到的指导原则。 博客文章提到了一个好的提交消息的7个目标,其中6个是由这些git-hooks强制执行的。 用空白行将主体与身体分开✓ 将主题行限制为50个字符✓ 大写主题行✓ 不要以句号结尾主题...

    git-version:用于PHP的基于Git commit哈希的版本管理器(未使用git命令)

    许多库原则上要求执行git命令,这不必要地启动了单独的进程。另外,许多开发人员自定义git命令或注册别名以更改其行为,并且存在无法在库中替换git命令的问题。这个库根本不使用git命令,但是允许您通过检索提交哈希...

    Git-2.30.0.2-64-bit.zip

    - `git commit -m "commit message"`:提交暂存区的更改。 - `git status`:查看当前工作区的状态。 - `git branch`:列出所有分支。 - `git checkout <branch>`:切换到指定分支。 - `git merge <branch>`:将...

    git使用流程和规范1

    3. **提交本地修改**:完成代码修改后,使用 `git add` 添加改动,然后使用 `git commit` 提交。 4. **合并并推送代码**:阶段性任务完成后,将代码合并到目标分支(如 feature/user-login),并使用 `git push` 推...

    蒋鑫:从Git社区看配置管理

    3. 提交(Commit):使用`git commit`命令,可以将更改保存到本地仓库的历史记录中。 4. 推送(Push):使用`git push`命令,可以将本地更改更新到远程仓库。 5. 拉取(Pull):使用`git pull`命令,可以将远程...

    Git学习笔记.pdf

    添加文件到仓库时,需要先使用git add命令将文件放入暂存区,然后使用git commit命令将暂存区的内容提交到仓库。版本回退则是通过git reset命令来实现,可以使用不同的参数来回退到历史的不同状态。 远程仓库是存放...

    ProGit.pdf

    - **多数操作仅添加数据**:Git 的设计原则之一是只添加数据而不修改现有的历史记录,这保证了数据的安全性。 - **三种状态**:工作目录、暂存区(索引)和仓库区。开发者可以通过这三个阶段管理文件的状态变化。 *...

    Git团队协作(基于GitHub)

    对于“代码提交操作”,需要掌握如何使用git add命令将更改添加到暂存区,使用git commit命令提交更改到本地仓库,以及使用git push命令将本地提交推送到远程仓库。为了确保协作顺畅,还需要理解如何使用分支进行...

    GIT_BEST_PRACTICES_GUIDE.pdf

    - **提交更改**:使用`git commit`命令将暂存区的更改提交到本地仓库。 - **查看状态**:通过`git status`命令查看当前工作区的状态。 - **撤销更改**:利用`git checkout`或`git reset`命令撤销文件的更改或恢复到...

    git分支版本管理.pdf

    - 在feature分支上进行开发,使用`git add`和`git commit`提交代码。 - 开发完成后,将feature分支合并回dev,如`git checkout dev && git merge feature1`,并解决可能出现的冲突。 - 测试阶段,从dev创建...

    关于Git安装,配置和使用教材,这一篇就够了

    git commit --amend -m "Corrected commit message" ``` #### 查看历史提交日志 查看提交历史,了解每次提交的变化: ```bash git log ``` #### 回滚代码仓库 如果需要撤销最后一次提交,可以使用以下命令: `...

    git的基本使用教程,把最基本的使用流程学会,在这个基础上再去学习。

    主要是git的一些使用说明,根据28原则,提取出了git里最重要,最基本的操作信息。 对于新人来说到公司,先git clone,或者git init 创建本地参数,然后git pull commit push,git branch,查看本地分支,然后git ...

    git操作教程

    基本的 Git 命令包括 `git init`、`git clone`、`git add`、`git commit`、`git push` 和 `git pull`。了解这些基础操作后,你还可以学习分支管理(`git branch`、`git merge`)、解决冲突、标签(`git tag`)以及回...

    Java 全栈知识点问题汇总(11).pdf

    在处理分支时,常用的操作包括`git status`检查当前状态,`git add -a`添加所有改动,再次`git status`确认,`git commit -m '描述'`提交,`git pull --rebase`更新本地分支,以及`git push`推送分支。 接下来是...

    Git基础入门学习教程

    - **提交更改**:使用`git commit -m "commit message"`命令将暂存区的更改提交到本地仓库。 - **查看版本历史**:使用`git log`命令查看提交的历史记录。 - **分支管理**: - 创建分支:使用`git branch ...

    pre-commit-golang:用于预提交的Golang钩子

    在Git版本控制系统中,`git hooks` 是一种强大的工具,...在实际开发过程中,结合`pre-commit-golang` 和Git的其他钩子,开发者可以构建出一套完整的代码质量管理流程,确保每次提交的代码都是经过充分验证和优化的。

Global site tag (gtag.js) - Google Analytics