コミットパターン

コミットパターン

セマンティックで専門的なコミットの書き方を学ぶ

コミットパターン

従来のコミットのドキュメントによると、セマンティック コミットはコミット メッセージで使用される単純な規則です。この規則は、明示的なコミット履歴を作成するための一連のルールを定義し、自動化ツールの作成を容易にします。 これらのコミットは、あなたとあなたのチームが、コミットされたコード部分にどのような変更が加えられたかをより簡単に理解するのに役立ちます。 この識別は、コミットされたコミットがコード変更、パッケージ更新、ドキュメント、ビジュアル変更、テストであるかどうかを識別する単語と絵文字によって行われます...

コミットの種類

セマンティック コミットには次の構造要素 (タイプ) があり、コードのユーザーにコミットの意図を伝えます。

✨

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

リポジトリの README などのドキュメントに変更があったことを示します (コードの変更は含まれません)。

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:
UIスタイリング💄:lipstick:
インフラストラクチャー🧱:bricks:
タスクリスト🔜:soon:
移動/名前変更🚚:truck:
新機能✨:sparkles:
JS の Package.json📦:package:
パフォーマンス⚡:zap:
リファクタリング♻️:recycle:
コードクリーニング🧹:broom:
ファイルの削除🗑️:wastebasket:
依存関係の削除➖:heavy_minus_sign:
応答性📱:iphone:
変更を元に戻す💥:boom:
安全🔒:lock:
SEO🔍: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"

ブランチの名前を変更

現在のブランチ (マスター) の名前を 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

コードスニペットを共有するためのツール。

💡重要なヒント

  • ✓何が変更されたのかを説明する、明確で説明的なメッセージを使用する
  • ✓コミットは小さくし、単一の機能に焦点を当ててください。
  • ✓正しいコミットタイプを使用して履歴のナビゲーションを容易にします
  • ✓コミットする前に必ず変更をテストしてください

参考文献