caveman-commit について
caveman-commit は、Conventional Commits 形式のコミットメッセージを簡潔に生成するスキルです。差分の内容を繰り返すより変更理由を示すことを重視しており、コミット履歴を簡潔に保ちたい開発者に向いています。
主な機能
- 01Conventional Commits 形式の件名
- 02件名は50文字前後を目安とし、上限は72文字
- 03理由が自明でない場合にのみ本文を追加
- 04破壊的変更とセキュリティ修正では本文が必須
- 05そのまま貼り付けられるコードブロックとして出力
活用シーン
- 01新しいエンドポイント追加時の簡潔なコミットメッセージ作成
- 02破壊的な API 変更の移行手順の記録
- 03以前のコミットを取り消す際の背景説明の追加
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ juliusbrussee/ caveman --skill caveman-commitインストール後、Claude Code で/caveman-commitを入力して読み込まれたか確認します。
同梱ファイルREADME.md
詳細
コミットメッセージは簡潔かつ正確に書きます。Conventional Commits 形式を使用します。余計な説明は不要です。何をしたかより、なぜ行ったかを重視します。
ルール
件名:
<type>(<scope>): <命令形の要約>—<scope>は省略可能- タイプ:
feat、fix、refactor、perf、docs、test、chore、build、ci、style、revert - 命令形:「add」「fix」「remove」。「added」「adds」「adding」は使いません
- 可能な限り 50 文字以内、上限は 72 文字
- 末尾にピリオドを付けません
- コロンの後の大文字・小文字は、プロジェクトの慣例に合わせます
本文(必要な場合のみ):
- 件名だけで内容が明確な場合は、本文を省略します
- 本文を追加するのは、明白でない 理由、破壊的変更、移行に関する注意事項、関連する Issue がある場合のみです
- 72 文字で折り返します
- 箇条書きには
*ではなく-を使います - Issue/PR の参照は末尾に記載します:
Closes #42、Refs #17
絶対に記載しないこと:
- 「This commit does X」「I」「we」「now」「currently」など。差分を見れば分かります
- 「As requested by...」— Co-authored-by トレーラーを使います
- 「Generated with Claude Code」や AI による生成を示す記載。ただし、ユーザー独自のルールで
Assisted-by/AI 帰属表示のトレーラーが必要な場合は、その限りではありません - 絵文字(プロジェクトの慣例で必要な場合を除く)
- スコープですでに示されているファイル名の繰り返し
例
差分:理由を本文で説明する、ユーザープロフィール用の新しいエンドポイント
- ❌ 「feat: データベースからユーザープロフィール情報を取得する新しいエンドポイントを追加」
- ✅
feat(api): add GET /users/:id/profile Mobile client needs profile data without the full user payload to reduce LTE bandwidth on cold-launch screens. Closes #128
差分:破壊的な API 変更
- ✅
feat(api)!: rename /v1/orders to /v1/checkout BREAKING CHANGE: clients on /v1/orders must migrate to /v1/checkout before 2026-06-01. Old route returns 410 after that date.
明確さの自動確保
以下の場合は、必ず本文を記載します:破壊的変更、セキュリティ修正、データ移行、以前のコミットを取り消す変更。これらを件名だけに圧縮しないでください。将来のデバッグに文脈が必要です。
範囲
コミットメッセージのみを生成します。git commit の実行、ファイルのステージング、コミットの修正は行いません。貼り付けて使えるコードブロックとして出力します。「stop caveman-commit」または「normal mode」と指定された場合は、詳しいコミットメッセージのスタイルに戻します。
コメント
Markdown 対応