💫

【GitHub】コミットメッセージに 「プレフィックス」 をつけよう

2022/03/02に公開約1,000字

commit message適当につけて
先輩から『なにやってるかわからん』と言われたことありませんか?

つよつよエンジニアの方は
この『プレフィックス』つけててすげーってなったのでまとめてみます。

プレフィックスをつけるってどういうこと?

以下のようにコミットメッセージの先頭に、なんらかの文字をつけること。

feat: xxx という機能を追加
fix: yyy で発生するバグを修正
refactor: zzz の機能をリファクタ

のように feat, fix, refactor などがプレフィックスです。

プレフィックス一覧

Angular.js の開発者ガイドに書いてあるメッセージを参考にしました。

実際にどう改善されるか?

改善前

改善後

feat: (新しい機能の追加)、style(スタイル調整)などです。ぱっと見でわかりやすい🐾

test なのか style 調整なのか、リファクタなのか、ライブラリの追加なのか?など。

レビュワーの負担を軽減することで、開発効率がアップすること間違いなしなので、ぜひ今すぐやりましょう🐶

プレフィックスで得られる恩恵

機能をプレフィックスレベルで分割して作るようになる
コミットが見やすくなる
レビューしやすくなる
コミットログを検索しやすくなる

=> 結果、開発効率が上がって開発速度が速くなる。

開発するときも、

  1. 「まずはライブラリを入れて (chore)」
  2. 「次にA機能のためのテスト書いて (test)」
  3. 「次にA機能を作って (feat)」
  4. 「最後にスタイル調整して (style)」

などのように、プレフィックスを意識しながら順序立てて機能を作成する癖が身につく。

Discussion

ログインするとコメントできます