76 lines (54 loc) · 2.09 KB

プロジェクトガイドライン

Git コミットメッセージ規約

基本ルール

言語: 日本語（language = "ja"）
ベース: Conventional Commits

フォーマット

<Prefix>: <サマリ（50文字以内、命令形）>

- 変更内容1
- 変更内容2
- ...

Refs: #<Issue番号>（任意）
BREAKING CHANGE: <内容>（任意）

Prefix 一覧

Prefix	用途
`feat`	新機能の追加
`fix`	バグ修正
`refactor`	リファクタリング（挙動変更なし）
`perf`	パフォーマンス改善
`test`	テスト追加/修正
`docs`	ドキュメント更新
`build`	ビルド/依存関係の変更
`ci`	CI関連の変更
`chore`	雑務（ツール設定/スクリプト等）
`style`	スタイルのみの変更（ロジック無関係）
`revert`	取り消し

スコープ付きも可: fix(auth): ..., feat(api): ...

メッセージ生成の原則

差分ベース: git diff / git diff --cached の実際の変更内容から生成
推測禁止: Issue タイトルやブランチ名だけから推測しない
箇条書き必須: 本文は必ず - で始まる箇条書きで列挙

禁止事項

曖昧なサマリ（update, fix bug, changes 等）
日本語以外だけでサマリを書く
箇条書きなしの長文本文
静的解析を迂回するだけの変更
機密ファイル（.env, credentials.json 等）のコミット

例

fix: 不要なデバッグログ出力を削除

- ユーザー情報取得処理の冗長なログ行を削除
- 必要な情報は残しつつログボリュームを削減

Refs: #123

🤖 Generated with AI assistance

refactor: 重複したバリデーション処理を共通関数へ集約

- フォーム入力チェックの重複コードをユーティリティ関数へ切り出し
- 呼び出し元の重複ロジックを削除し可読性を向上
- 挙動の変更はなし

🤖 Generated with AI assistance