Git Commit 提交规范

写好 Commit message 好处多多：

1、统一团队Git commit 日志风格
2、方便日后 Reviewing Code
3、帮助我们写好 Changelog
4、能很好的提升项目整体质量

业界比较推崇 Angular 的 commit 规范 http://suo.im/4rsYee

Commit message 包括三个部分：Header，Body 和 Footer。完整格式如下：

<type>(<scope>): <subject>

<BLANK LINE>

<body>

<BLANK LINE>

<footer>

1) type

提交 commit 的类型，包括以下几种

- feat: 新功能

- fix: 修复问题

- docs: 修改文档

- style: 修改代码格式，不影响代码逻辑

- refactor: 重构代码，理论上不影响现有功能

- perf: 提升性能

- test: 增加修改测试用例

- chore: 修改工具相关（包括但不限于文档、代码生成等）

2) scope

修改文件的范围，比如：视图层、控制层、docs、config, plugin

3) subject

- subject 是 commit 目的的简短描述（用一句话清楚的描述这次提交做了什么），不超过50个字符

4) body

- 补充 subject 添加详细说明，可以分成多行，适当增加原因、目的等相关因素，也可不写

5 ) footer

- 当有非兼容修改(Breaking Change)时必须在这里描述清楚

- 关闭issue或是链接到相关文档，如 Closes #1, Closes #2, #3

原文地址：https://www.cnblogs.com/feixiablog/p/9023084.html

时间： 2024-08-30 03:40:43

Git Commit 提交规范的相关文章

规范git commit提交记录和版本发布记录

在开发过程中我们一般都会用到git管理代码,在git commit提交代码时我们一般对git commit message随便写点简单的描述,可是随着项目参与人数的增多,发现提交的commit记录越来越杂乱,不便查阅,在网上找了下解决方案,总结一下方便在公司项目中运用. commit message 格式目前大家比较认可的是Angular团队的提交规范,很多工具也是基于此规范开发的.该提交规范格式如下: <type>(<scope>): <subject> <B

Git代码提交规范

git提交规范化 commit messge规范十分有助于项目管理,目前使用最多的是Angular团队的规范主要规范是: type: commit的类型 feat: 新特性 fix: 修改问题 refactor: 代码重构 docs: 文档修改 style: 代码格式修改,非css test: 测试用例修改 chore: 其他修改,比如构建流程,依赖管理 scope: commit影响的范围,比如: route, component, utils, build... subject: comm

windows和ubuntu下git commit提交后如何保存和退出，回到命令行

问题一: windows下git commit后会进入vim界面,不知道怎么操作解决办法: 1.输入小写字母i,此时进入编辑模式,可以输入你想输入的内容 2.按下esc键,此时退出编辑模式,输入英文语法下的冒号:,再输入wq即可保存退出 3.也可以按下esc退出编辑模式之后连续按输入两个大写字母Z退出问题二: Ubuntu下git commit后会进入类似vim界面,不知道怎么操作解决办法: 1.Ubuntu下git commit后进入的是nano界面 2.输入需要内容后按下ctrl+x会

git comit 提交规范

更多文章 <type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer> 大致分为三个部分(使用空行分割): 标题行: 必填, 描述主要修改类型和内容主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等页脚注释: 放 Breaking Changes 或 Closed Issues type: commit 的类型 feat: 新

commitizen和cz-customizable配置git commit message

起因团队对提交的commit message格式有约定俗称的要求,但是没有一个统一的规范,导致大家提交的commit message或多或少不太一样.因此,需要一个工具来帮助大家统一commit message的格式,也方便后续的分析和拓展. commitizen commitizen 是一个帮助规范commit message的工具.安装后的效果如下图: 安装commitizen npm install -g commitizen 安装adapter commitizen根据不同的adapt

DigApis编码提交规范白皮书

python 代码风格:PEP8规范,参考注释规范: 2.1. 文件头: #!/usr/bin/env python # -*- coding: utf-8 -*- # @Author : Jason # @Mail : [email protected] # @File : 文件名.py 2.2. 类注释: class SampleClass(object): """Summary of class here. Longer class information.... L

git commit

git commit git commit命令提交stage区的快照到项目历史中去(HEAD). 被提交的快照被认为是一个项目的安全版本. Git不会修改他们, 除非你显示的要求了. 和git add一样git commit是Git最重要的命令之一. 尽管名字相同git commit和svn commit完全不一样. 快照被提交到本地仓储, 不会和其他git仓储有任何的交互影响. 用法 git commit 提交stage区的快照. 上面的命令运行后会自动打开一个文本编辑器让你写一些关于这次c

GIT入门笔记（20）- git 开发提交代码过程梳理

git开发提交流程新项目开发,可以直接往master上提交老项目维护,可以在分支上修改提交,多次add和commit之后,也可以用pull合并主干和本地master,解决冲突后再push 1.检出代码 git clone http://gitserver/kubernetes/api-gateway-controller.git git clone http://gitserver/kubernetes/api-gateway-engine.git 引入为eclipse工程,修改代码 2.提交代

Eclipse git commit错误；Committing changes has encountered a problem An Internal error occured

背景在使用eclipse时,使用git commit 提交代码时,出项如下错误解决方法在工程目录下找到 .git 文件夹 ,找到里面的 index.lock 文件,然后删掉这个文件就可以了,如下图原文地址:https://www.cnblogs.com/jixue/p/9581675.html