自分の中の整理を含めてまとめました。
はじめに
Git はコミット時にコミットメッセージは必須です。
チーム開発している時にも、このコミットはなんなのか？を初めに伝える重要な指標でもあります。
より良い開発にはコミットメッセージは重要なのです。
また、コミットメッセージなしにコミットしようとすると中止されます。
# Please enter the commit message for your changes. Lines starting
# with ‘#’ will be ignored, and an empty message aborts the commit.
#
# On branch main
# Your branch is up to date with ‘origin/main’.
#
# Changes to be committed:
# new file: README.md
#
Gitのコミットメッセージの書き方
要点をまとめる
だいたい30文字程度でまとめることが多いです。
fix: ログイン時のエラーハンドリングを修正改行を入れて詳しく書く方もいますが、それはPull RequestのDescriptionに書いた方が良いと思っています。
Prefixをつける
Prefixをつけることで、コミットの種類が明確になります。
| プレフィックス | 用途 |
|---|---|
feat | 新機能の追加 |
fix | バグ修正 |
refactor | リファクタリング（機能変更なしのコード改善） |
style | コードのフォーマット修正（動作に影響なし） |
docs | ドキュメントの変更 |
test | テストの追加・修正 |
chore | ビルドやライブラリ関連の変更 |
feat: ユーザーログイン機能を追加こちらのSemantic Commit Messagesを参考にしました。改めて整理ができます。ありがとうございます。
refs: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
Summary
個人的にはコミットにPrefixをつけると、レビューのしやすさが上がったり、バグ発生時の調査などに当たりをつけやすくなるので好きです。
実際には1つの機能を作るまでに何度かコミットすると思います。適宜Squashするとコミットが整理できます。(GitHubの「スカッシュ マージを許可する」でも良い。)
