LoginSignup
0
0

More than 3 years have passed since last update.

コミットコメントにプレフィックスを含めると分かりやすくなる

Posted at

プレフィックス

angular.jsのDEVELOPERS.mdを参考

  • feature: 機能追加
  • fix: バグ修正
  • docs: ドキュメント修正
  • style: コードスタイル修正(フォーマッター適用など)
  • refactor: リファクタリング。機能追加やバグ修正など、動作を変更するものは入れないこと!!
  • performance: パフォーマンス向上目的の修正
  • test: テスト系のみの修正

参考のほうは、略称を使ったりしていたがブランチ名にも使いたいため、略さずにつけることにした。

あと、ライブラリ修正とか細かすぎるかなぁと思うところは消した。

ブランチ名も合わせる

  • feature/converter
  • fix/converter
  • refactor/converter

などなど

感想

職場でもコミットコメントのプレフィックス付ける部分のみやってみたが、リリース時の今回修正分確認が分かりやすくなり、非常に良かった。

ブランチ名を合わせるところまでやると、ブランチ一覧で大体の進行度合いが分かり、良さそうではある。

featureのコードレビュー時に、規模の大きいリファクタリングが入っていると、かなり辛くなるので、上記意識するとそういうのが無くなるかも?的な期待もある。

とりあえず、コミットコメントの先頭プレフィックスだけでもやってみるのが、コスパも良いしおすすめ。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0