🐈

コミット、ブランチ、プルリクにはプレフィックスをつけよう〜💪

に公開

はじめに

開発をしていて、コミットメッセージやブランチの命名、

プルリクのタイトルって悩みませんか?

私はそれなりに悩みます💦

悩んだは良いものの、上記の内容に色々と込めようとして、

良かれと思って説明的になってしまい、

色々と書き過ぎて冗長になってしまうことってありますよね。。。

まぁ、私はあります😅

それに、これらの命名を考えるのもちょっと面倒ですよね💦

まぁ、私も面倒です。。。

そこで読み手にとってより簡潔で分かりやすくなり、

かつ楽に運用できそうな方法がありましたので、

今回はこれを記事にしてみたいと思います!

プレフィックスをつけてみよう💪

結論から言うと

プレフィックスをつける



たったそれだけです。

例えば何らかの新規開発、機能追加であるならば...

feat or feature

これをプレフィックスとしてつけてみましょう。

feat/何を?

feat:何を?

こんな感じですね。

同様に修正系ですと...

fix/何を?

fix:何を?

リファクタリングですと...

refactor/何を?

refactor:何を?

テスト関連ですと...

test/何を?

test:何を?

それ以外の雑多なものなら...

chore/何を?

chore:何を?

こんな感じですね。

https://www.conventionalcommits.org/en/v1.0.0/



こちらで紹介されているプレフィックスを使って運用すると

なお良さそうですね☺️

Jiraを使っているならブランチの『何を?』にチケット番号を付けることで

トレーサビリティも担保出来ますし、

より内容も手短に出来ますので良いですよ〜🎶

...

あれっ、これってJiraの運用でも使えるのでは。。。!?



to be continued...

参考

https://www.conventionalcommits.org/en/v1.0.0/

Discussion