git项目commit message编写规范

最新推荐文章于 2024-08-06 10:24:56 发布
最新推荐文章于 2024-08-06 10:24:56 发布
阅读量1.3k 收藏 3
点赞数
分类专栏： 【杂记】 文章标签： git commit message规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/juzipidemimi/article/details/79915534
版权

查看知名仓库的commit提交记录都有鲜明的风格，能清晰的了解到此次commit修改的类型，修改了什么内容，以及覆盖的范围等

常见的格式：

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

type是commit的类型：

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

scope是影响的范围，可以是组件或者文件等。
subject是commit的描述信息。
body是commit的一些更具体的修改内容。
footer可以放置一些备注，例如相关的issue。

使用示例（来自vue的仓库提交记录）

在这里插入图片描述

神以灵
关注
专栏目录
git commit message 编写规范
小美哥的博客
05-13 1666
git是软件开发过程中必不可少的代码管理工具，在每次提交新代码时，需要写一些信息表示本次提交所改动的内容。为了方便日后的管理与迭代，commit message最好能有一些固定的格式，让人一眼就能知道每一次提交所做的修改。本文分享一下开源社区常用的代码提交规范，仅供参考。 完整的commit message格式如下: &amp;amp;lt;type&amp;amp;gt;(&amp;amp;lt;scope&amp;amp;gt;): &amp;amp;lt
git commit message编写指南
jeezx
12-21 2255
0. Commit message编写指南 【声明】参考angular代码规范及部分博客整理，仅学习记录，非商用。 1. 概述 日常开发中使用 git 提交代码要求一定要写 git commit message，否则就无提交代码。 commit message作为改动说明，保存在 commit 历史中，方便回溯。 规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。 规范git commit到底有哪些好处呢？ 便于程序员对提交历史进
Commit message 和 Change log 编写指南
流水不腐小夏
01-06 1821
转载http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。 $ git commit -m "hello world" 上面代码的-m参数，就是用来指定 commit mesage 的。 如果
后端必备的 Git Commit Message规范指南-直接食用
最新发布
a0987654321abc的博客
08-06 118
IDEA中规范使用Git Commit Message，包括插件安装、使用和讲解，通过git hooks进行校验。
Git Commit Message 格式规范
linyiheng123的专栏
05-31 837
(): // 空一行// 空一行
Git commit 常见用法
热门推荐
Blog
07-02 2万+
Git commit git commit 主要是将暂存区里的改动给提交到本地的版本库。每次使用git commit 命令我们都会在本地版本库生成一个40位的哈希值，这个哈希值也叫commit-id，commit-id在版本回退的时候是非常有用的，它相当于一个快照,可以在未来的任何时候通过与git reset的组合命令回到这里. 1.1 git commit -m “message” 这种是比较常...
Git Commit Message规范
qq_25775675的博客
10-13 2152
Git commit message规范是一种良好的实践，可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。
Git 提交的正确姿势：Commit message 编写指南
一年又一年。的专栏
03-27 1759
Git 提交的正确姿势：Commit message 编写指南 文章目录 一、Commit message 的作用 二、Commit message 的格式 2.1 Header 2.2 Body 2.3 Footer 2.4 Revert 三、Commitizen 四、validate-commit-msg 五、生成 Change log http://www.ruany......
【知识整理】Git Commit Message 规范_commit message rule violation
2401_84167086的博客
05-06 901
每次提交，Commit Message 都包括三个部分：Header，Body 和 Footer。Commit Message 提示说明示例。
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6339
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
Commit-Message-Plugin:提交信息模板规范化插件
05-19
Commit-Message-Plugin 提交信息模板规范化插件 一、代码提交规范化的目的 为了部门提交代码信息格式规范化 为了更好的追溯代码、筛选 为了更加快速的定位提交代码所涉及的范围和实现功能 为了后续代码的Review、自动生成ChangeLog 二、代码提交信息规范模板 本模板修改自《Angular代码提交规范》,分为Header、Body两大块内容，去除Footer，这一部分我们并不常用 [Bug修复](4.27.10):http://jira.xyz.cn/browse/XYZDEV-9043 原因分析:需求内容不完整或错误 Header 1、提交类型 【新增功能】-【新的功能点、新的需求】 【Bug修复】-【修复的Bug:现网发散Bug、测试阶段的Bug、验收阶段的Bug】 【文档修改】-【只是修改了文档:注释、README.md等】. 【样式修改】-【不影响代码功能的修
写出好的 commit message
AlienTech for better life!~
12-26 1875
为什幺要关注提交信息 加快 Reviewing Code 的过程帮助我们写好 release note5年后帮你快速想起来某个分支，tag 或者 commit 增加了什么功能，改变了哪些代码让其他的开发者在运行 git blame 的时候想跪谢总之一个好的提交信息，会帮助你提高项目的整体质量 基本要求 第一行应该少于50个字。 随后是一个空行 第一行题目也可以写成：Fix i
IDEA 中 Git Commit message 编写
只有变秃 才能变强
08-14 1万+
IDEA Commit message 编写 参考: Commit message 和 Change log 编写指南 安装插件 Git Commit Template Create a commit message with the following template: (): <footer> 1. Header Header的部分只有一行,包括三个字...
Git Commit Message 编写指南
qq_45949848的博客
10-21 260
Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。上面代码的-m参数，就是用来指定 commit mesage 的。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。目前，社区有多种 Commit message 的。本文介绍（见上图），这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。
Git Commit message 规范
Wiliam的博客
02-07 5104
Git Commit message 规范介绍格式HeaderBodyFooterRevert常用示例featfixdocsstylerefactorperftestchorerevert参考链接 介绍 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 git commit -m "芜湖~起飞" 上面代码的-m参数，就是用来指定 commit message 的。 如果一行不够，可以只执行 git commit
git 代码提交(git commit -m 'message')--04
javaZhong的博客
06-06 1710
git commit -m [message] # 将暂存区提交到仓库区git commit [file1] [file2] ... -m [message] # 将暂存区中的指定文件提交到仓库区git commit -a # 提交工作区自上一次commit之后的变化，直接到仓库区git commit --amend [file1][file2] ... # 重做上一次的commit，并包括指定文...
android commit规范
JALLV的博客
01-20 3516
Commit规范 在团队开发过程中，如果大家Commit Message不统一或者写的不清晰，很难看出一次提交修改了哪些内容。对于codereview来说也很难作为参考。目前，社区有多种 Commit message 的写法规范，这里推荐使用angular规范，格式如下： <type>(<scope>): <subject> <空行> <body> <空行> <footer> 其中 head（(): ）是必须的，body和
Git使用规范(Android版)
Dream It Possible
08-22 3052
引言 本文根据Git分支管理策略，结合Git Flow分支管理实践，制定了这个适合Android开发中的Git版本管理规范。同时结合实际操作演示了使用示例，希望对你有所帮助。 1. 各分支简介 下面分支中提到的的 version 应该替换为具体的版本，name 应该替换为具体的开发人员姓名，content 应该替换为需要优化的地方。 master分支 git的默认分⽀，主分支，不...
git commit message helper
09-01
git commit message helper是一个辅助工具，用于帮助我们编写更好的git提交信息。 在进行版本控制时，我们通常会使用git进行代码管理，并且会通过提交(commit)来记录每次的修改。一个好的提交信息可以让其他人更容易理解我们做了哪些修改以及修改的原因。 git commit message helper可以提供以下功能： 1. 提供格式规范：git commit message helper可以为我们提供一份提交信息的格式规范。这样，在编写提交信息时，我们可以按照这个规范来进行，以遵循一致的风格。 2. 提示关键信息：git commit message helper可以通过自动补全或显示相关选项来提示我们填写关键信息。比如，当我们输入某个关键词时，它可以自动给出一些常见的选项供我们选择，以避免遗漏重要信息或填写错误。 3. 语法检查：git commit message helper可以帮助我们进行提交信息的语法检查。它可以检查是否符合规范，是否存在拼写错误等，从而提供更准确的提交信息。 4. 快捷操作：git commit message helper可以提供一些快捷操作，以便更方便地编写提交信息。比如，可以设置快捷键或命令来快速填写某些常用的信息，如修改的模块、bug修复等。 总而言之，git commit message helper是一个实用工具，可以帮助我们编写更好、更准确的提交信息。它不仅可以提高版本控制的效率，还有助于团队合作和代码维护的规范性。使用这个工具可以在一定程度上提高代码开发和管理的效果。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值