はじめに
チーム開発において、「内容がわからないコミット」や「必須修正か判断がつかないレビュー」は、開発速度を落としストレスの原因になります。
この問題を解決するのがプレフィックスを活用したテキストの標準化です。
本記事では、「Conventional Commits (公式サイト: http://conventionalcommits.org/ja/v1.0.0/ )」と「コメントプレフィックス」の2つを軸に、明日から使えるチーム開発の標準ルールを解説します。
【コミット編】Conventional Commits で履歴を美しく
チーム開発でコミットメッセージがバラバラだと、変更履歴を辿るのが大変になります。そこで使われている共通のルールが Conventional Commits です。
一言で言えば、「コミットメッセージの先頭に feat: や fix: といった型をつけるというフォーマット」です。
1. 基本のフォーマット
Conventional Commits では以下のフォーマットでコミットメッセージを書くルールになっています。
<type>[optional scope]: <description>
例: feat(auth): ログイン画面にパスワード表示切替を追加
2. 主要な型（Type）
<type>部分には代表的に以下のような型が用いられます。
| Type | 意味 | 使うタイミング |
|---|---|---|
| feat | 新機能 | ユーザー向け機能の追加 |
| fix | バグ修正 | コードの不具合修正 |
| docs | ドキュメント | READMEやコメントなど、ドキュメント類のみの変更 |
| style | スタイル | コードの動作に影響しない修正（インデント、空白、セミコロンの追加など） |
| refactor | リファクタリング | バグ修正も機能追加も行わない、コードの整理・構造改善 |
| test | テスト | テストコードの追加や修正 |
| chore | 雑作業 | ビルドプロセス、パッケージ追加、その他各種設定ファイルの変更 |
※互換性のなくなる重大な変更（BREAKING CHANGE）を加える場合は、feat!: のように Type の直後に ! を付与します。
3. 導入メリット
- コミットメッセージに悩む時間が減る: 選択肢が絞られるため、思考コストが下がります。
- 変更履歴（CHANGELOG）を自動生成できる: ツール（release-please など）を使ってリリースノートの作成を自動化できます。
【レビュー編】コメントプレフィックスで指摘の意図を明確にする
プルリクエストのコードレビューでも、「プレフィックス」を活用することでコミュニケーションの行き違いを防止できます。コードレビューでは単なる修正指示だけではなくそのコメントの重要度を正確に伝えることが重要です。
1. よく使われるプレフィックス
| プレフィックス | 意味・ニュアンス | 修正の必要性 |
|---|---|---|
must | 必須の修正（バグや仕様違い） | 修正必須 |
nits | 些細な指摘 | 任意 |
imo | 私の考え・提案 | 任意 |
praise | 褒め言葉 | 修正不要 |
2. コメントプレフィックスの具体例
- 【must】
must: APIキーがハードコードされています。環境変数から読み込むように修正をお願いします。 - 【nits】
nits: 変数名が usr になっています。 user の方が可読性が高いかもしれません。 - 【praise】
praise: 複雑なロジックがすごく綺麗にリファクタリングされていて読みやすいです！
3. レビューにつけるメリット
- 認知負荷とストレスが減る: 指摘を見た瞬間に「すぐ直すべきか後回しで良いか」判断できます。
- やり取りの確認コストが減る: 「これ直さなきゃダメですか？」という確認の往復がなくなり、PRのマージ速度が向上します。
プレフィックス運用を定着させる2つのコツ
ルールを決めただけでは形骸化しがちです。自然に定着させるためのポイントを以下で紹介します。
1. ツールを使って仕組みで自動化する
人間の意識に頼らず、Gitフックツールの husky + commitlint を導入して規約違反のコミットを自動で弾くなど、システムでサポートするのが最も効果的です。
2. 使う種類を絞って小さく始める
最初からすべての型を覚えさせようとするとメンバーが拒絶反応を起こしてしまいます。
- コミット用:
feat/fix - レビュー用:
must/nits
まずは上記のように 2〜3個程度 に絞って導入し、チームが慣れてきたら徐々に種類を増やしていきましょう。
まとめ
コミット＆レビューのプレフィックス運用の本質は、次に読む相手（未来の自分やチームメンバー）の認知負荷を減らす配慮です。
コミットに feat: や fix: をつけてみたり、コードレビューで nits: や praise: を添えてみることで、チーム全体の開発体験を大きく高めるきっかけになります。
