👏

Git conventional commitまとめ

2022/05/03に公開

はじめに

gitのcommitメッセージについて、開発チーム内で規約などを定めているでしょうか?
私は前職の開発チームでは、メンバー間でgitのcommitメッセージに関して規約などを定めていない中で開発を進めておりました。
一方で現職の開発チームでは、社内の開発チームのメンバー間で共通された規約を用いてcommitメッセージを書くことが定められており、commitメッセージに関してチーム内で共通のフォーマットを用いて運用を行うことに一定のメリットがあることに気がついたので記事にまとめます。

conventional commit

社内の開発チーム内では全チームで共通して、基本的には conventional commit に従ってコミットメッセージを残しております。

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

業務内で頻繁に利用するcommitメッセージのフォーマット

chore: some message
chore(module name): some message
feat: some message
feat(module name): some message

example

feat(backend): implement XxxService
chore(refactor): apply misc refactoring
chore(doc): add getting started section to README.md

チーム内で共通の規約を定めることのメリット

本番環境での障害発生時に、commitメッセージからリポジトリの変更履歴を辿ることが容易になることが考えられます。

Discussion

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