美文网首页
git commit规范

git commit规范

作者: vincent_wei28 | 来源:发表于2017-10-28 20:04 被阅读0次

Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。
一般来说,commit message 应该清晰明了,说明本次提交的目的。
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
其中,Header 是必需的,Body 和 Footer 可以省略。
不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

header

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

<type>(<scope>): <subject>// 空一行<body>// 空一行<footer>
type

Merge: merge branch
Feature: a new module to have faster process, 表示新增(Add)
Update: update something
Refactor: improved the implementation of module X, 表示重构(Refactory)
Bugfix: fixed a bug

scope

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

subject

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

好的commit信息建议
touch README.md
git init
git add README.md
# git commit -m "first commit" # 命令行添加提交信息
git commit # 编辑器添加提交信息
七条很棒的 git 提交信息规则
记住:这都是之前都说过的。

1.用一个空行隔开标题和正文
2.限制标题字数在 50 个字符内
3.用大写字母写标题行
4.不要用句号结束标题行
5.在标题行使用祈使语气
6.正文在 72 个字符处换行
7.使用正文解释是什么和为什么,而不是如何做

相关文章

  • 使用 git hook 规范 Android 项目

    引言 本文所说的『规范』包含两个部分 git commit 是注释的规范 git commit 时对代码规范的检查...

  • git commit规范

    git commit规范 git-commit规范 在多人协作项目中,如果代码风格统一、代码提交信息的说明准确,那...

  • gitflow 规范及工具整理

    gitflow 进阶规范 git cz 通过工具 git-cz 规范 git commit 提交信息。 使用 gi...

  • GIT 规范

    git 规范 git 规范一般包括两点:分支管理规范和 git commit 规范。 分支管理规范 一个项目可以创...

  • git操作

    git规范 Git 使用规范流程 团队中的 Git 实践 Git: 教你如何在Commit时有话可说 Git工作流...

  • Git Commit message(Angular规范)

    Git Commit message(Angular规范) Commit message 的格式 1. Heade...

  • git commit 提交规范(优化)

    git commit 提交模板和规范 Git每次提交代码,都要写 Commit message(提交说明),否则就...

  • 用 git 钩子,检测代码规范性(eslint、standard

    最终实现效果说明: 用 git commit 提交代码之前,利用 pre-commit git 钩子,实现代码规范...

  • git提交规范

    git的规范和相关科普知识 git commit 的规范要求(参考Angular团队) message格式如下: ...

  • 我的git学习日志

    关于提交规范(git commit conventions) 参考文献: 你可能会忽略的 Git 提交规范Comm...

网友评论

      本文标题:git commit规范

      本文链接:https://www.haomeiwen.com/subject/vxnspxtx.html