提交模式

提交模式

学习编写语义和专业的提交

提交模式

根据常规提交文档,语义提交是在提交消息中使用的简单约定。该约定定义了一组用于创建显式提交历史记录的规则,这使得创建自动化工具变得更加容易。 这些提交将帮助您和您的团队更轻松地了解对所提交的代码段进行了哪些更改。 这种识别通过单词和表情符号进行,识别所提交的提交是否是代码更改、包更新、文档、视觉更改、测试...

提交类型

语义提交具有以下结构元素(类型),它们向代码用户告知您提交的意图。

feat

指示您的代码片段包含新功能(与语义版本控制中的 MINOR 相关)。

git commit -m ":sparkles: feat: adicionar autenticação de usuário"
🐛

fix

表示您提交的代码片段正在解决问题(错误修复),它与语义版本控制中的 PATCH 相关。

git commit -m ":bug: fix: corrigir loop infinito na validação"
📚

docs

表示文档已发生更改,例如存储库的自述文件中(不包括代码更改)。

git commit -m ":books: docs: atualizar README com instruções"
💄

style

表示存在与代码格式、分号、空格、lint 相关的更改(不包括代码更改)。

git commit -m ":lipstick: style: corrigir formatação do código"
♻️

refactor

指由于重构而导致的不改变功能的变化,例如由于代码审查而导致的性能改进。

git commit -m ":recycle: refactor: otimizar algoritmo de busca"

perf

它用于识别任何与性能相关的代码更改。

git commit -m ":zap: perf: melhorar tempo de carregamento"
🧪

test

当对测试进行更改时使用,无论是创建、修改还是删除单元测试(不包括代码更改)。

git commit -m ":test_tube: test: adicionar testes unitários"
🔨

build

当修改构建文件和依赖项时使用。

git commit -m ":package: build: atualizar dependências"
🧱

ci

表示与持续集成相关的更改。

git commit -m ":bricks: ci: configurar pipeline de deploy"
🔧

chore

表示构建任务、管理设置、包的更新(不包括代码更改)。

git commit -m ":wrench: chore: atualizar .gitignore"
🗃️

raw

表示与配置文件或原始数据相关的更改。

git commit -m ":card_file_box: raw: dados brutos do projeto"
🧹

cleanup

表示代码清理、删除不必要的注释和一般优化。

git commit -m ":broom: cleanup: remover código não utilizado"
🗑️

remove

表示删除不再需要的文件、功能或代码。

git commit -m ":wastebasket: remove: deletar arquivos obsoletos"

表情符号图案

提交类型表情符号关键词
无障碍:wheelchair:
添加测试:white_check_mark:
更新子模块版本⬆️:arrow_up:
降级子模块版本⬇️:arrow_down:
添加依赖项:heavy_plus_sign:
代码审查变更👌:ok_hand:
动画和过渡💫:dizzy:
错误修复🐛:bug:
评论💡:bulb:
初始提交🎉:tada:
设置🔧:wrench:
部署🚀:rocket:
文档📚:books:
进行中🚧:construction:
用户界面样式💄:lipstick:
基础设施🧱:bricks:
任务清单🔜:soon:
移动/重命名🚚:truck:
新功能:sparkles:
JS 中的 Package.json📦:package:
表现:zap:
重构♻️:recycle:
代码清理🧹:broom:
删除文件🗑️:wastebasket:
删除依赖项:heavy_minus_sign:
反应能力📱:iphone:
恢复更改💥:boom:
安全🔒:lock:
搜索引擎优化🔍:mag:
版本标签🔖:bookmark:
通过测试✔️:heavy_check_mark:
测试🧪:test_tube:
文本📝:pencil:
打字🏷️:label:
错误处理🥅:goal_net:
数据🗃️:card_file_box:

主要 Git 命令

克隆存储库

将现有的远程 GitHub 存储库克隆到本地环境。

git clone url-do-repositorio-no-github

初始化存储库

在当前目录中初始化一个新的 Git 存储库。

git init

添加文件

将当前目录中的所有文件和更改添加到暂存区域。

git add .

进行提交

使用描述性消息记录添加到暂存区域的更改。

git commit -m "mensagem do commit"

重命名分支

将当前分支(master)重命名为 main。 -M 用于强制重命名。

git branch -M main

添加远程存储库

将名为 origin 的远程存储库添加到本地存储库。

git remote add origin https://github.com/usuario/nome-do-repositorio.git

发送到存储库

将提交从本地分支发送到远程存储库。

git push -u origin main

从存储库更新

使用远程存储库中的更改更新本地分支。

git pull origin main

连接本地存储库

当您已有本地存储库并希望将其连接到 GitHub 上的远程存储库时。

git remote add origin git@github.com:usuario/projeto.git
git branch -M main
git push -u origin main

获取更新

从远程存储库获取所有更新,而不将它们合并到当前分支中。

git fetch

安全强制推动

强制将本地更改推送到远程存储库的更安全方法。

git push --force-with-lease

恢复提交

创建一个新的提交,撤消指定提交所做的更改。

git revert id_do_commit_que_vai_ser_revertido

重置提交

将存储库重置为指定的提交状态,删除所有后续更改。

git reset --hard id_do_commit_anterior_ao_que_vai_ser_apagado

更改提交消息

更改上次提交的消息。

git commit --amend -m "mensagem_reescrita"

樱桃采摘

用于从另一个分支获取特定提交。

git cherry-pick HASH_DO_COMMIT

交换分行

切换到本地存储库中的不同分支。

git switch <branch>

词汇表

fork

将存储库复制到您自己的 GitHub 帐户。

issues

用于管理任务和错误修复的工具。

pull request

用于向原始存储库提交建议更改的机制。

gist

用于共享代码片段的工具。

💡重要提示

  • 使用清晰的描述性消息来解释已更改的内容
  • 保持较小的提交并专注于单一功能
  • 使用正确的提交类型使历史导航更容易
  • 在提交之前始终测试您的更改