git comit 提交规范

更多文章

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

大致分为三个部分(使用空行分割):

  1. 标题行: 必填, 描述主要修改类型和内容
  2. 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
  3. 页脚注释: 放 Breaking Changes 或 Closed Issues

type: commit 的类型

  • feat: 新特性
  • fix: 修改问题
  • refactor: 代码重构
  • docs: 文档修改
  • style: 代码格式修改, 注意不是 css 修改
  • test: 测试用例修改
  • chore: 其他修改, 比如构建流程, 依赖管理.
  • scope: commit 影响的范围, 比如: route, component, utils, build...
  • subject: commit 的概述

body: commit 具体修改内容, 可以分为多行.

footer: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.

示例

fix（修复BUG）

如果修复的这个BUG只影响当前修改的文件，可不加范围。如果影响的范围比较大，要加上范围描述。

例如这次 BUG 修复影响到全局，可以加个 global。如果影响的是某个目录或某个功能，可以加上该目录的路径，或者对应的功能名称。

// 示例1
fix(global):修复checkbox不能复选的问题
// 示例2 下面圆括号里的 common 为通用管理的名称
fix(common): 修复字体过小的BUG，将通用管理下所有页面的默认字体大小修改为 14px
// 示例3
fix: value.length -> values.length

feat（添加新功能或新页面）

feat: 添加网站主页静态页面

这是一个示例，假设对页面内容进行了一些描述。

这里是备注，可以是放BUG链接或者一些重要性的东西。

chore（其他修改）

chore 的中文翻译为日常事务、例行工作，顾名思义，即不在其他 commit 类型中的修改，都可以用 chore 表示。

chore: 将表格中的查看详情改为详情

其他类型的 commit 和上面三个示例差不多，在此不再叙述。

原文地址：https://www.cnblogs.com/woai3c/p/11800312.html

时间： 2024-10-07 11:09:58

git comit 提交规范的相关文章

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

Git代码提交规范

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

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

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

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分支管理规范

原文地址: http://blog.jboost.cn/2019/06/17/git-branch.html 许多公司的开发团队都采用Git来做代码版本控制.如何有效地协同开发人员之间,以及开发.测试.上线各环节的工作,可能都有各自的流程与规范.本文分享的是作者一直沿用的团队项目Git分支管理规范,希望给有缘阅读的人以参考,如果有更好的实践,也欢迎探讨.交流. 分支管理 创建项目时(一般是服务型项目,工具型或辅助型项目可以简单一些),会针对不同环境创建三个常设分支: develop:开发环境的稳

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.提交代

git 每次提交需要输入密码

亲测可行(第一种) 原文:git每次提交都要输入密码怎么办 ＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝COPY＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝ 不少用户反映在使用Git时,经常会遇到需要频繁输入密码的情况,那么,Ubuntu系统中git每次提交都要输入密码怎么办?该怎么避免呢?下面跟着学习啦小编一起来了解一下吧. git每次提交都要输入密码解决方法操作步聚如下: git每次提交都要输入密码解决方法一: 1: cd 回车;进入当前用户目录下; 2: vim .git-credentia

git 克隆,提交

git clone git-url git add . git comm -a -m ' desc ' git push ..然后还有一个.. 如果一直提示 *** Please tell me who you are. Run git config --global user.email "[email protected]" git config --global user.name "Your Name" to set your account's defau

轻松使用git命令提交代码

Github在Windows和Mac上都提供了很好的图形化的客户端,UI风格节约,功能轻松易用.但是我们仍然有必要熟悉git命令来维护代码,比如linux. 借用@sunshyran总结的git提交代码的五个步骤: 查看代码的修改状态 查看代码的修改内容 暂存需要提交的代码 提交已暂存的文件 同步到服务器 Step1.查看代码的修改状态 打开git shell(环境:以windows为例,安装好Github的客户端并配置好账户信息), 默认是在git的工作空间路径,ls命令可以查看workspa