fix: 直したって何をよ?地獄コミットメッセ問題、ギャルがConventional Commitsで救う🌈
この記事では、gitのコミットメッセージにありがちな失敗例と、Conventional Commitsのルールに基づいた書き方を、ギャル風にやさしく解説しちゃうよ💅✨
「fix: 修正」だけじゃ伝わらないってば!未来の自分もチームも笑顔になれるコミットメッセのコツ、ぜ〜んぶ教えちゃう💖
🌀 コミットメッセージ失敗例|地獄のログにしないために
ある日チームのGitログ見て、マジで震えたんだけど…
fix: 修正
update: test
change: 少し変更
aaa
test
やばい
no message
修正2
バグじゃなかったわ
コミットできた〜!!
🙄 なにを直した?どこで?なんのために?意味不明すぎてヤバ〜!
Gitログって未来の自分とか他の開発者に向けたラブレター💌なのに、
このままだと**「謎ポエム」か「黒歴史日記」**じゃん!?
Gitはドキュメント!メッセージは未来のあたしへのラブコール💘
✅ gitで使えるコミットメッセの書き方(Conventional Commitsってやつ✍️)
以下のルール守るだけで、
検索しやすくて分かりやすい、チームに超優しいログが爆誕しちゃうの🌟
<type>(scope): なにしたか
* 補足(必要ならね)
* チケットのURLとかIDとか
例:
fix(auth): JWTの期限切れチェック修正💫
* LocalDateTimeの比較を統一✨
* トークンの有効期限処理を見直したよん
チケット: #1234
✍️ よく使うConventional Commitsのタイプ一覧だお💖
type | 内容 | 例 |
---|---|---|
feat |
新機能の追加 | 検索機能追加など✨ |
fix |
バグ修正 | ログイン時のクラッシュ修正とか💥 |
docs |
ドキュメント変更 | README更新〜📄 |
style |
見た目だけの変更 | Lint対応とかね🌈 |
refactor |
振る舞いは変えない中身改善 | 命名変更・関数分割など💡 |
test |
テスト関係 | 単体テスト追加しといたよ🧪 |
chore |
その他の雑務 | 依存パッケージ更新とか🛠️ |
💡 VSCode拡張とかcommitlintとか使えば、ルールもバッチリ守れるよ💻💅
💬 コミットメッセージの書き方Tips(ギャルの極意)
- 1コミット1トピックが鉄則!「ついでに」はNGだよ〜🙅♀️
- **改行とか箇条書きで読みやすく!**見た目大事っしょ?
- スコープ(どこ修正したか)書くと超助かる💘
- なんでその修正したのかも書いてくれると未来のあたしが泣いて喜ぶ😭
🎯 実務で使えるイケてるコミットメッセージ例💖
feat(uploader): 健診CSVアップロード機能つけたった✌️
* 一時保存処理入れた〜
* StorageServiceにアップ処理書いた✨
* エラハン仮対応してあるから見といて!
チケット: #5678
fix(path): Windowsでパス崩壊するバグ潰した💥
* 区切り記号の重複なくしたよ!
* Paths.get()に揃えた〜
チケット: #7890
docs(readme): セットアップ手順追加したよん📝
* 初期構築方法書いたよ〜!
* 環境変数のとこ補足したっちゃ〜
チケット: #1357
😱 ダメコミットあるある集
メッセージ | ツッコミ |
---|---|
aaa |
何それ?サウンド?🎶 |
やばい |
お前がやばい😇 |
修正2 |
修正1どこに落とした!? |
バグじゃなかったわ |
戻してこいや〜!🌀 |
no message |
マジで無!闇〜🖤 |
🛠 開発効率爆上がりツール一覧🧰
- VSCode拡張: Conventional Commits ★GUI楽でオススメ!
- commitlint + husky でチェックもバッチリ✔️
- Cursor でAIちゃんにアシストしてもらお💕
🎤 まとめ:良いコミットメッセは未来の自分を救う✨
ちょっとした気遣いで、
開発スピードもレビュー効率も、Gitログの神っぽさもぜんぶ爆上がり💥
みんなでConventional Commits使えば、
Gitが史上最強の開発ドキュメントになるってば📚✨
📣 あとがき:PLやってるギャルからひとこと💄
いまPLとして、要件定義〜保守まで全部ガッツリ関わってるけどさ、
ログがちゃんとしてるだけで、プロジェクトのストレス爆減するってマジで体感してる✌️
この記事いいじゃんって思ったら、LGTM・シェア・コメントで推して〜🙏💋
「ギャル風の技術記事もっと読みたい!」って声も待ってるよん🌈
ちなこれ次回の記事!
なんでConventional Commitsってそんなに大事なの?Git履歴は“構造”なのよねって話🌈