---
title: コミットメッセージ
description: Conventional Commits に準拠したコミットメッセージの書き方
---

## 基本方針

コミットメッセージは [Conventional Commits 1.0.0](https://www.conventionalcommits.org/ja/v1.0.0/) に準拠し、description と body は日本語で書きます。

Conventional Commits を使う理由は次のとおりです。

- **変更内容の明確化**: コミットの目的が一目で分かる
- **リリースノートの自動生成**: 変更履歴を自動的に作成できる（[リリースノート](/deploy-release/release#リリースノート)を参照）
- **セマンティックバージョニング**: バージョン番号を自動で決定できる
- **チーム内の統一**: 誰が書いても同じ形式になる

:::note[develop の履歴に残るのは PR のタイトルと説明文]
トピックブランチは `develop` へ Squash and merge するため（[マージ戦略](/git/pull-request#マージ戦略)）、`develop` の履歴に残るのは PR のタイトルと説明文です。トピックブランチの各コミットのメッセージや footer は残りません。
PR のタイトルもこのページの形式で書き、課題の参照は PR の説明文に書いてください（[Pull Request 運用](/git/pull-request#タイトル)）。
:::

:::tip[commitlint で検査する]
形式の確認は人の目に頼らず、[commitlint](https://commitlint.js.org/) を Lefthook などの Git hook ツールの `commit-msg` フックで実行して検査してください。
:::

## フォーマット

```txt
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

- **type**: コミットの種類（必須）
- **scope**: 変更の範囲（省略可）
- **description**: 変更内容の簡潔な説明（必須）
- **body**: 詳細な説明（省略可）
- **footer**: 破壊的変更や課題の参照（省略可）

説明が不要な短い修正は、1 行のみで構いません。

## type

### 主要な type

| type       | 説明                                     | 例                                                |
| ---------- | ---------------------------------------- | ------------------------------------------------- |
| `feat`     | 新機能の追加                             | `feat: ユーザー登録機能を追加`                    |
| `fix`      | バグ修正                                 | `fix: ログインフォームのバリデーションエラーを修正` |
| `docs`     | ドキュメントのみの変更                   | `docs: README のセットアップ手順を更新`           |
| `style`    | コードの意味に影響しないフォーマット変更（CSS による見た目の変更は含まない） | `style: Prettier でフォーマット`                  |
| `refactor` | リファクタリング（機能変更なし）         | `refactor: API クライアントを関数化`              |
| `perf`     | パフォーマンス改善                       | `perf: 画像の遅延読み込みを実装`                  |
| `test`     | テストの追加・修正                       | `test: ユーザー認証のテストを追加`                |
| `chore`    | 他の type に当てはまらない雑務（設定ファイル、依存関係の更新など） | `chore: 依存関係を更新`                           |

### その他の type（任意）

| type     | 説明                     | 例                                        |
| -------- | ------------------------ | ----------------------------------------- |
| `build`  | ビルド設定の変更         | `build: Vite の設定を更新`                |
| `ci`     | CI 設定の変更            | `ci: GitHub Actions のワークフローを追加` |
| `revert` | 以前のコミットの取り消し | `revert: ユーザー登録機能の追加を取り消し` |

## scope

scope は変更の範囲を示します（省略可）。

```txt 例
feat(auth): ログイン機能を追加
fix(api): ユーザー取得のエラーハンドリングを修正
docs(readme): セットアップ手順を追記
fix(button): ボタンの余白をデザインに合わせる
```

scope には次のようなものを使います。

- コンポーネント名: `button`、`header`、`modal`
- ページ名: `top`、`about`、`contact`
- 機能領域: `auth`、`form`、`search`

scope はプロジェクト内で統一すると、履歴を検索しやすくなります。

## description

description は変更内容を簡潔に説明します。

- **動作を表す語で終える**: 「〜を追加」「〜を修正」「〜を更新」など
- **過去形にしない**: 「追加した」ではなく「追加」
- **簡潔に**: 全角 30 文字程度を目安に
- **具体的に**: 何を変更したか明確に

**良い例**

```txt
feat: ユーザー認証機能を追加
fix: ログインフォームのバリデーションエラーを修正
docs: API 仕様書を更新
refactor: データ取得ロジックを共通化
```

**悪い例**

```txt
update
fix bug
変更
WIP
```

## body

description だけでは説明しきれない場合は、空行を挟んで body に詳細を書きます。

```txt 例
feat: メール通知機能を実装

SendGrid を使用したメール送信処理を追加。
次のイベントの発生時に通知を送信する。
- ユーザー登録完了
- パスワードリセット
- 重要なアカウント変更

環境変数 SENDGRID_API_KEY の設定が必要。
```

## footer

### 破壊的変更

API の変更など、後方互換性のない変更がある場合は footer に `BREAKING CHANGE:` で明記します。

```txt
refactor: 環境変数名を変更

BREAKING CHANGE: 環境変数の命名規則を統一。
次の環境変数名を変更した。
- API_URL → PUBLIC_API_URL
- DB_URL → DATABASE_URL

.env ファイルの更新が必要。
```

type の後ろに `!` を付けても破壊的変更を示せます（例: `refactor!: 環境変数名を変更`）。

### 課題の参照

関連する課題がある場合は、footer で参照します。

```txt
fix: ログインエラーを修正

Closes #123
```

```txt
feat: 検索機能を追加

Refs: PROJ-123
```

- **GitHub の Issue**: `Closes #123` などのキーワードを書くと、デフォルトブランチ（`develop`）にマージされたときに Issue が自動でクローズされます
- **Backlog の課題**: `Refs: PROJ-123` のように課題キーを書き、どの課題の変更かを追えるようにします
