はじめに
Gitを使ってバージョン管理をしていると、コミットミスをしてしまうことは誰でも経験があるはずです。「コミットメッセージを間違えた」「内容を修正したいけどどうすればいいの？」と悩んだことがある方のために、git commit --amendを使った修正方法について解説します。
この記事は個人的なアウトプットを目的として作成したものです。そのため、誤った情報や不足している内容が含まれている可能性があります。もし間違いや気になる点がございましたら、ぜひご指摘いただけますと幸いです。
git commit --amendを使用する
git commit --amend とは
「amend」とは「修正する」「改心する」「正す」といった意味を持つ単語です。その名の通り、git commit --amendは直前のコミットを修正するためのコマンドです。
git commit --amend で出来ること
git commit --amendを使うと、以下の2つの修正が可能です。
コミットメッセージの修正
例えば、誤ったコミットメッセージを修正するには以下のように操作します。
git commit -m "誤字のコミット" # 誤ったコミット
git commit --amend -m "正しいコミット" # 修正したメッセージ
コミット内容の修正
# 修正内容を反映
git add example.txt
# 直前のコミットを修正
git commit --amend
注意点
1つ重要なポイントとして、git commit --amendは基本的にpush前のコミットに対してのみ使用してください。
すでにリモートリポジトリにpushされたコミットを修正すると、他の開発者と履歴が不一致になり、混乱を引き起こす可能性があります。その場合、新しいコミットを作成するなど、別の方法で対処しましょう。
終わりに
git commit --amendは、直前のコミットを修正するための便利なコマンドです。このコマンドを適切に活用すれば、コミットメッセージや内容を整理し、履歴をきれいに保つことができます。また、きれいな履歴を維持することで、他の開発者が変更内容を追いやすくなり、レビューの効率も向上します。
ただし、--amendの使用には注意が必要です。リモートにpush済みのコミットには使用を避け、新しいコミットを作成するなど適切な方法で対応してください。
参考
『コミットの修正には git commit --amend が便利』
『git commit --amend でコミット後の小さい修正を前のコミットにまとめる』Zenn