Open wallleap opened 2 years ago
title: 规范化 Commit 提交信息 date: 2022-07-29 14:30 updated: 2022-07-29 14:30 author: 小康 cover: //cdn.wallleap.cn/img/pic/illustrtion/202207261551425.jpg category: 技术杂谈 tags:
文章转载自小康博客
写此文的目的仅仅是为了在 commit 操作时方便快速查找表情符号。因此参考互联网中同类型文章整理此文。
commit
在使用命令行提交 commit 消息时，可以通过 :关键字: 的方式进行使用表情。
:关键字:
git commit -m ":tada: Initial commit"
使用时可以复制需要的 emoji 代码
:art:
:zap:
:racehorse:
:fire:
:bug:
:ambulance:
:sparkles:
:memo:
:rocket:
:lipstick:
:tada:
:white_check_mark:
:lock:
:apple:
:penguin:
:checkered_flag:
:robot:
:green_apple:
:bookmark:
:rotating_light:
:construction:
:construction_worker:
:green_heart:
:arrow_up:
:arrow_down:
:pushpin:
:chart_with_upwards_trend:
:recycle:
:whale:
:globe_with_meridians:
:heavy_plus_sign:
:heavy_minus_sign:
:wrench:
:hammer:
:pencil2:
:hankey:
:rewind:
:twisted_rightwards_arrows:
:package:
:alien:
:truck:
:page_facing_up:
:boom:
:bento:
:ok_hand:
:wheelchair:
:bulb:
:beers:
:speech_balloon:
:card_file_box:
:loud_sound:
:mute:
:busts_in_silhouette:
:children_crossing:
:building_construction:
:iphone:
:clown_face:
:egg:
:see_no_evil:
:camera_flash:
:alembic:
:mag:
:wheel_of_dharma:
:label:
<emoji 代码><type>(<scope>): <subject>
<type>
用于说明 git commit 的类别，只允许使用下面的标识。 以下表格来自阿里技术
用于说明 git commit 的类别，只允许使用下面的标识。
git commit
以下表格来自阿里技术
feat
fix/to
fix
to
docs
style
refactor
perf
test
chore
revert
merge
sync
<scope>
scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
例如在 Angular，可以是 $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView 等。
Angular
$location
$browser
$compile
$rootScope
ngHref
ngClick
ngView
如果你的修改影响了不止一个 scope，你可以使用 * 代替。
scope
*
<subject>
subject 是 commit 目的的简短描述，不超过 50 个字符。
subject
建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
结尾不加句号或其他标点符号。
:bug: fix(DAO): 用户查询缺少username属性 :sparkles: feat(Controller): 用户查询接口开发
vscode 中 Git-commit-plugin 插件可以快速生成提交模板。
Git-commit-plugin
设置项
展示 Emoji
默认为 true。可在设置中修改
true
提交类型
增加其他的提交类型，需要在 json 中添加。
"GitCommitPlugin.CustomCommitType": [ { "label": "customTypeName", "detail": "customTypeDetail" } ]
subject 最大长度
subject 的最大长度限制，默认为 20。可在设置中修改。
https://github.com/typicode/husky
https://commitlint.js.org/#/
gitmoji
Git 提交时的 emoji 表情使用指南
git commit 规范指南
如何规范你的 Git commit？
本文转载自：规范化 Commit 提交信息 | 小康博客 (antmoe.com)
title: 规范化 Commit 提交信息 date: 2022-07-29 14:30 updated: 2022-07-29 14:30 author: 小康 cover: //cdn.wallleap.cn/img/pic/illustrtion/202207261551425.jpg category: 技术杂谈 tags:
Git description: 规范化 Commit 提交信息
文章转载自小康博客
写此文的目的仅仅是为了在
commit操作时方便快速查找表情符号。因此参考互联网中同类型文章整理此文。使用
在使用命令行提交
commit消息时，可以通过:关键字:的方式进行使用表情。表情列表
使用时可以复制需要的 emoji 代码
:art::zap::racehorse::fire::bug::ambulance::sparkles::memo::rocket::lipstick::tada::white_check_mark::lock::apple::penguin::checkered_flag::robot::green_apple::bookmark::rotating_light::construction::construction_worker::green_heart::arrow_up::arrow_down::pushpin::chart_with_upwards_trend::recycle::whale::globe_with_meridians::heavy_plus_sign::heavy_minus_sign::wrench::hammer::pencil2::hankey::rewind::twisted_rightwards_arrows::package::alien::truck::page_facing_up::boom::bento::ok_hand::wheelchair::bulb::beers::speech_balloon::card_file_box::loud_sound::mute::busts_in_silhouette::children_crossing::building_construction::iphone::clown_face::egg::see_no_evil::camera_flash::alembic::mag::wheel_of_dharma::label:提交预览
提交格式
参数说明——
<type>featfix/tofix：产生 diff 并自动修复此问题。适合于一次提交直接修复问题to：只产生 diff 不自动修复此问题。适合于多次提交。最终修复问题提交时使用 fixdocsstylerefactorperftestchorerevertmergesync参数说明——
<scope>scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
例如在
Angular，可以是$location,$browser,$compile,$rootScope,ngHref,ngClick,ngView等。如果你的修改影响了不止一个
scope，你可以使用*代替。参数说明——
<subject>subject是 commit 目的的简短描述，不超过 50 个字符。建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
结尾不加句号或其他标点符号。
示例
工具
VScode
vscode 中
Git-commit-plugin插件可以快速生成提交模板。设置项
展示 Emoji
默认为
true。可在设置中修改提交类型
增加其他的提交类型，需要在 json 中添加。
subject 最大长度
subject 的最大长度限制，默认为 20。可在设置中修改。
其他
https://github.com/typicode/husky
https://commitlint.js.org/#/
文章参考
gitmoji
Git 提交时的 emoji 表情使用指南
git commit 规范指南
如何规范你的 Git commit？