gitのコミットメッセージ💬
皆さんgitつかってますか！？
開発者だと、gitにコミットすることは多々あると思いますが、コミットメッセージのルールをチームで定めたので、さらーっと書いてみます！
少しでもみなさんの参考になればうれしいです！
自分たちのコミットメッセージのルール
[Emojis] [Prefix] [バージョン] [issue 番号] [コミットの内容]
例) ✨ add v0.1 #100 △△機能の○○する処理を追加
それぞれどんなルールなのか、ちょっと詳細にかいてみます。
目次
Emoji
絵文字は一目見ただけでどんな修正をしたのかを把握することができます。
🐛だったら、バグ直したんだな～～とか、
📚だったら、なんかのドキュメント追加か更新したんだな～となります。
あとなんといっても、、コミットのログがカラフルでかわいくなります！！！（重要）
主はコミットするときやコミットログを見たときにテンションを上げたいので、アイコンの採用を激推ししました🎉
Emojiのルールはこちらの記事を参考にさせていただいています🎨
絵文字 説明 🎉 初めてのコミット（Initial Commit） 🔖 バージョンタグ（Version Tag） ✨ 新機能（New Feature） 🐛 バグ修正（Bugfix） ♻ リファクタリング(Refactoring) 📚 ドキュメント（Documentation） 🎨 デザイン UI/UX(Accessibility) 🐎 パフォーマンス（Performance） 🔧 ツール（Tooling） 🚨 テスト（Tests） 💩 非推奨追加（Deprecation） 🗑️ 削除（Removal） 🚧 WIP(Work In Progress)
VSCodeで使いやすくするために
我々は、VSCodeで開発しているので、絵文字入力に便利な拡張機能をいれてます！
サジェストしてくれるので、便利。
カイゼンできそうなポイント
今のEmojiルールだと、文言の修正などのしょうもない修正も🐛になってしまうので、コミットが🐛🐛🐛だらけになりがちです😢
この方は、ちょっとした修正には🩹を使用されているので真似してみてもいいかも？と思っています。
🐛との使い分けは一瞬で修正できるなら🩹、機能そのものに問題がありしっかり取り組む必要があるなら 🐛というイメージです。
Prefix
これはシンプルにコミットの種別を表すものです。
この記事から拝借させてもらってます。
私たちはライト版にして、ルールは4個だけにしています。ライトじゃない方は、もっといろんなのがありそう。
| Prefix | 説明 |
|---|---|
| fix | バグ修正 |
| add | 新規（ファイル）機能追加 |
| update | 機能修正（バグではない） |
| remove | 削除（ファイル） |
バージョン
リポジトリのバージョンを書きます。我々はバージョンの先頭に"v"をつけて書いています。
これバージョンいつの時の修正だ？っていうのがわかりやすくなります。
issue番号
gitlabを使ってリソースの管理をしているので、issueの番号を書いて、どのissueに紐づいた修正なのかがぱっとわかるようになります。
gitlabはissue番号の先頭に"#"をつけると、issueに飛べるようになり、どんなissueの内容だったか確認しやすいです。(たぶんgithubも)
コミットの内容
これはシンプルにコミットした内容を要約したものを書いています。
短くわかりやすい文をかけるように気をつけてかいています。
おわり
コミットメッセージって、こうであるべきっていうのがないと思うので、他の方はどんなルールで運用されているのか気になってきました。。。（誰か教えて）
こんなの使ってるよとか、もっとかわいくわかりやすくする方法をしってるよって方は、コメントなどして教えてくれると飛んで喜びます～！