Gitコミットガイドライン
コミットメッセージの書式
<タイプ>(<スコープ>): <タイ語または英語の件名>
[オプションの本文]
タイプ
| タイプ | 使用タイミング |
|---|
feat | 新機能またはページの追加 |
fix | バグ修正 |
refactor | 振る舞いを変えずにコードを再構成 |
style | UI/CSSの変更のみ(ロジック変更なし) |
chore | 設定、依存関係、ツール(prisma generateなど) |
docs | ドキュメントまたはコメント変更 |
perf | パフォーマンス改善 |
このプロジェクトに合わせたスコープ
| スコープ | 対応するパス |
|---|
auth | src/lib/auth.ts、src/lib/auth-client.ts、(auth)/ ルート |
product | (front)/product/、app-product-card.tsx |
cart | src/lib/cart-store.ts、カートコンポーネント |
course | (front)/course/、src/services/course-service.ts |
contact | (front)/contact/、src/app/api/contact/ |
prisma | prisma/schema.prisma、src/lib/prisma.ts |
ui | src/components/ui/、src/components/ |
layout | (front)/layout.tsx、(auth)/layout.tsx |
api | src/app/api/ |
config | next.config.ts、prisma.config.ts、.env |
件名のルール
- 英語のみ使用する
- 短い文で72文字以内にする
- 末尾にピリオドを付けない
- 現在形を使用する:「added」「fixed」ではなく「add」「fix」「update」
例
feat(product): add product detail page
fix(cart): fix totalPrice calculation when qty is 0
chore(prisma): regenerate Prisma client after schema changes
style(ui): update badge color in hero component
refactor(auth): extract signIn logic from page component
feat(api): add GET /api/products endpoint with pagination
fix(contact): prevent XSS in email HTML template
注意点
.env ファイルはコミットしないこと — BETTER_AUTH_SECRET および DATABASE_URL が含まれています
generated/prisma/ ファイルはgitignoreされています — ステージしないでください
- スキーマを変更した場合は、スキーマをコミットする前に
npx prisma generate を実行すること
- 理由なく
--no-verify を使用してフックをスキップしないこと
コミット前のチェックリスト