代码工程必备能力—Commit 规范

最新推荐文章于 2024-04-12 08:33:25 发布
最新推荐文章于 2024-04-12 08:33:25 发布
阅读量5.8k 收藏 9
点赞数 2
文章标签： 1024程序员节
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/benjaminparker/article/details/120942232
版权

Git是目前应用最为广泛的开源分布式版本控制系统，不论是对企业团队还是科研任务都需要掌握使用Git的技巧，文章重点在于总结如何使用Git的一些功能，包括讲述的文章、资源和个人的想法。

Git 官方网址：Git

一. Git Commit 的作用（干啥用的）

        Git Commit：指的是提交说明，用于标注此次修改的内容以及需要提示的信息,官方给出的解释是：Record changes to the repository（记录添加到仓库当中的修改）。

        提供一个场景来做理解：

        代码团队合作编写项目A，我作为开发人员从 Github 拉取代码到本地创建了分支A_1,并在这个分支上做了修改。假定这个修改的内容是为项目代码的某个文件增加了功能模块，将这部分修改提交到缓存当中，执行：

git add .

        我想将工程上传到Github当中并希望团队的负责人审查之后，将我的功能模块并入到主模块当中，这个时候就需要告诉这个负责人我修改了什么，尤其在面对非常多的提交的时候，让负责人尽快地定位到关键内容，查看Commit信息就显得非常重要了。

        当然，Commit对于自己维护代码和查看工作进程等方面都有非常重要的作用，每一个计算机人员在使用Git管理工程时候都应当保有Commit的习惯。

二. Git Commit 的正确打开方式（怎么用）

        Git Commit命令用于将更改记录(提交)到存储库。将索引的当前内容与描述更改的用户和日志消息一起存储在新的提交中，以下是Git Commit命令的具体参数列表

git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
	   [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
	   [--date=<date>] [--cleanup=<mode>] [--[no-]status]
	   [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
	   [(--trailer <token>[(=|:)<value>])…​] [-S[<keyid>]]
	   [--] [<pathspec>…​]

常用的有三种参数形式：

1. 命令行直接添加修改信息

git commit -m "描述提交修改的信息"

2. 使用文本编辑器添加修改信息

git commit

直接使用指令会弹出电脑的默认编辑器，然后直接编辑内容即可。当保存（Ctrl + S）之后关闭编辑器就完成了此次提交。

3. -a 会先把所有已经track的文件改动`git add`进来，直接提交而不需要每次都先执行Git add . 

git commit -a

4. -amend 是增补提交，会使用与当前提交节点相同的父节点进行一次新的提交，旧的提交将会被取消，这样就不需要为了修改Commit的内容而再次提交一次。

git commit --amend

 关于Git Commit更多的详细使用方式：

廖雪峰： 简单直接上手的Git Commit操作和讲解

易百教程： 详细讲述了Git  Commit和 Git  Add 之间的恩怨情仇

官网：每一个参数的具体解释

可视化使用Commit教程：IDEA， SourceTree , TortoiseGit

一般每一个IDE只要右键都能够发现对应的Git选项，其中会集成一部分功能的可视化。

三. Git Commit 的行业规范（遵守的规矩）

Git Commit 最大的价值就是标注信息，那如何才能够最高效地标识清楚修改的内容就是Git Commit的最大意义。

目前，社区有多种 Commit message 的写法规范。本文介绍Angular 规范是目前使用最广的写法，比较合理和系统化，并且有配套的工具。前端框架Angular.js采用的就是该规范。

目的是：
 

  • 可读性好，清晰，不必深入看代码即可了解当前commit的作用。

  • 为 Code Reviewing做准备

  • 方便跟踪工程历史

  • 让其他的开发者在运行 git blame 的时候想跪谢

  • 提高项目的整体质量，提高个人工程素质

以下是在GitHub 上查看提交修改时候的界面

 来看其中具体的一条

 按照这个标准，规定Commit的文字部分格式：

格式要求包括三个部分： Header,Body和Footer；其中，header 是必需的，body 和 footer 可以省略。

<type>(<scope>): <subject>
<BLANK LINE> #空行的意思
<body>
<BLANK LINE>
<footer>

1.  Header：

        Header部分只有一行，包括三个字段：type 、scope、subject

        这三部分分别对应图片当中红蓝黄三个部分的内容，一个比较好的Commit信息，应当包含完全必要的修改内容。

type 用于说明 commit 的类别，只允许使用下面7个标识。 
> feat：新功能（feature）
> fix：修补bug 
> docs：文档（documentation）
> style： 格式（不影响代码运行的变动）
> refactor：重构（即不是新增功能，也不是修改bug的代码变动）
> test：增加测试
> chore：构建过程或辅助工具的变动

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

例如在Angular，可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等。

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

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

其他注意事项：

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

2. 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行是空行

  • 应该说明代码变动的动机，以及与以前行为的对比。

3. Footer

（1）不兼容变动

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.

 以BREAKING CHANGE开头的Footer,主要用在当前代码和上一个版本不适应的时候

（2）关闭 Issue

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

Closes #265

参考资料：

[1] Git Commit Message StyleGuide: slashsbin/styleguide-git-commit-message: /sBin/StyleGuide/Git/CommitMessage (github.com)

[2]  Commit message 和 Change log 编写指南 BY 阮一峰:  Commit message 和 Change log 编写指南 - 阮一峰的网络日志 (ruanyifeng.com)

[3] Abe Stanway // abe.is

[4] Git Commit Message Conventions: Git Commit Message Conventions - Google 文档

[5] GitKraken -- 超好用的 Git 可视化工具 - 知乎 (zhihu.com)

benjaminparker
关注
  • 2
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
前端工程化之commit规范（代码提交规范）
codingWeb的博客
11-02 1万+
其实commit规范不管是前端还是后端也好，我觉得吧，在任何的工程化的项目中都是不可或缺的部分啦，commit 提交不规范，项目维护和管理起来是极其麻烦的，毕竟每个人都具有自己的个性，commit的格式也是参差不齐 git 可以帮我们很好地管理代码，但是在多人合作的时候，经常会碰到各种随意的 commit message，当你需要会看 commit message 的时候，就会很头疼。 幸运的是我们可以使用工具去处理掉这个问题，不让这种小问题影响到项目的进展 首先来看一下被业界广泛认可的 Angular
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6028
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
2023 年了，还有前端人不知道 commit 规范 ？
qq_41838305的博客
04-26 584
约定式提交（Conventional Commits）是一种用于代码版本控制的规范，旨在通过明确和标准化提交信息来提高代码协作质量和效率。其基本原则是通过规定提交信息的结构和语义来提高代码版本控制的可读性、可维护性和自动化程度。约定式提交规范通常要求提交信息包括一个描述性的"类型"、一个可选的"作用域"、一个用于简洁说明的"主题"，以及可选的"正文"和"尾部"等组成部分。
【Git】commit提交代码
春天的波菜
06-30 6956
接 katalon配置git与git项目创建_春天的菠菜的博客-CSDN博客it提交代码的正确步骤命令?在程序员们进行代码开发时，常常会使用到git这款代码管理工具，但是不少新手在学习git时不知道git提交代码的正确步骤，导致常常代码提交失败，那么今天小编就来告诉大家git提交代码的正确步骤命令，帮助大家正确的提交代码。git提交代码的正确步骤命令1、提交代码第一步：git status查看当前状态。当你忘记修改了哪些文件的时候可以使用git status来查看当前状态，红色的字体显示的就是你修改的文件;
git commit命令
最新发布
unber的博客
04-12 923
git commit命令用于将更改记录(提交)到存储库。将索引的当前内容与描述更改的用户和日志消息一起存储在新的提交中。Shell。
commit 规范
weixin_43416349的博客
07-11 2423
feat: 新增了内容 docs：修改了文档
git commit提交规范
axzzy的博客
11-03 1758
📈 (上升趋势图) :chart_with_upwards_trend : 添加分析或跟踪代码。🏁 (旗帜) :checkered_flag : 修复 Windows 下的问题。🌐 (地球) :globe_with_meridians : 国际化与本地化。✅ (白色复选框) :white_check_mark : 增加测试。💚 (绿心) :green_heart : 修复 CI 构建问题。🐧 (企鹅) :penguin : 修复 Linux 下的问题。🔒 (锁) :lock : 修复安全问题。
codereview.chromium
07-13
《Chromium代码审查指南——Java开发者的必备知识》 在软件开发领域，代码审查是确保代码质量、提高团队协作效率的重要环节。对于Java开发者来说，理解并遵循特定项目的代码审查规范至关重要，尤其是在像Chromium...
working:工作编码
05-10
理解Git的基本命令如`clone`、`add`、`commit`、`push`和`pull`，以及如何解决冲突，是现代开发者的必备技能。 软件工程实践，如敏捷开发和测试驱动开发（TDD），也是工作编码的重要组成部分。敏捷开发强调迭代和...
南大软工一作业
04-11
10. **编码规范**：遵循统一的编码规范可以提高代码的可读性。学生应熟悉并遵循如Google Java Style Guide或Oracle的Java编程规范。 通过这些作业，学生将全面掌握Java编程的基础，并逐步培养出良好的编程习惯和...
dibericky
03-20
了解Git的基本操作，如`clone`（克隆）、`commit`（提交）、`push`（推送）、`pull`（拉取）、`merge`（合并）等，是每个开发者必备的技能。掌握Git的工作流，如Git Flow或GitHub Flow，能有效地协同开发和维护项目...
Software_Engineering_2
03-08
14. **文档和编码规范**：编写清晰的文档和遵循一定的编码风格，如PEP 8，可以提高代码的可读性和维护性。学会使用Sphinx或Read the Docs来生成项目文档，也是专业程序员的基本素养。 通过深入学习以上知识点，并...
2023年了，还有开发人员还不知道commit 规范 ？？
freezingmaple的博客
04-09 404
一个开发人员需要知道的 commit 规范 什么是约定式提交 约定式提交（Conventional Commits）是一种用于代码版本控制的规范，旨在通过明确和标准化提交信息来提高代码协作质量和效率。
git commit 提交规范 & 规范校验
tangsiqi130的博客
07-13 1536
git commit 提交规范 & 规范校验
git 提交中的commit 规范
weixin_46761843的博客
08-06 3444
最近又接受一个项目，上面的eslint各种规范真的是稍不注意就会出问题。也是在网上找了很多，感觉下面的总结很好的解决了我的困境。记录一下。方便下次查看。 一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工.
git commit 提交规范
qq_47885323的博客
01-09 1291
如果影响的是某个目录或某个功能，可以加上该目录的路径，或者对应的功能名称。chore 的中文翻译为日常事务、例行工作，顾名思义，即不在其他 commit 类型中的修改，都可以用 chore 表示。commit 影响的范围, 比如: route, component, utils, build...如果修复的这个BUG只影响当前修改的文件，可不加范围。如果影响的范围比较大，要加上范围描述。一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.commit 的概述。
Git Commit 之道：规范化 Commit Message 写作指南
pursuit的博客
11-12 7106
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
git commit规范
09-06
Git Commit规范是一种约定俗成的方式，用于规范化提交信息的格式和内容，使得提交历史更加清晰、易读和易于管理。以下是一种常见的Git Commit规范： 1. 提交信息的结构：每个提交信息由三个部分组成：标题、正文和页脚。 标题：简明扼要地描述这次提交的内容，通常以动词开头，使用一般现在时，不超过50个字符。 正文：对提交的详细描述，可以包括为什么进行该提交、做了哪些修改等信息。 页脚：可包含与提交相关的其他附加信息，如关联的Issue编号、作者等。 2. 提交信息的格式：为了保持统一和易读性，可以采用以下格式： ``` <type>(<scope>): <subject> <body> <footer> ``` 其中，`<type>`代表提交的类型，如`feat`（新功能）、`fix`（修复bug）、`docs`（文档更新）等。 `<scope>`代表本次提交的范围，可以是具体的文件、模块或功能名称。 `<subject>`是对本次提交内容的简要描述。 `<body>`是对本次提交内容的详细描述。 `<footer>`是页脚部分，可以包含相关链接、引用等信息。 3. 示例： ``` feat(user): 添加用户注册功能 - 在用户界面增加注册表单 - 后端增加注册接口 Issue #123 ``` 通过遵循Git Commit规范，可以提高团队协作效率、减少沟通成本，并且更好地追踪和管理项目的提交历史。当然，具体的规范可以根据团队的实际需求和偏好进行调整和定制。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值