commit について
Conventional Commits に沿った Git コミット作成を支援するスキルです。変更の確認、タイプとスコープの選択、簡潔な件名や本文の記述方法を案内します。
主な機能
- 01Conventional Commits のタイプと形式
- 02件名と本文の記述指針
- 03任意のスコープと破壊的変更表記
- 04コミット前のステージ変更確認
活用シーン
- 01機能追加や修正のコミット整形
- 02破壊的変更のコミットでの説明
- 03コミット前のステージ済みファイル確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ nweii/ agent-stuff --skill commitインストール後、Claude Code で/commitを入力して読み込まれたか確認します。
詳細
コミット
Conventional Commitsに従って、適切に整形された Git コミットを作成します。
形式
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
種類
feat:新機能fix:バグ修正docs:ドキュメントのみstyle:書式設定、セミコロンの不足など(コード変更なし)refactor:バグ修正や機能追加を伴わないコード変更perf:パフォーマンスの改善test:不足しているテストの追加chore:保守作業(ビルドプロセス、依存関係など)
ガイドライン
- 件名:命令形(「added」ではなく「add」など)にします。50 文字以内を目安にしてください。
- 本文:72 文字で折り返し、何を、なぜ変更するのかを説明します。どのように変更するかは説明しません。
- スコープ:任意です。コードベース内の領域を示します(例:
feat(auth):)。 - 破壊的変更:種類またはスコープの後に
!を付け(例:feat!:)、フッターで説明します。
手順
- ステージされた変更(
git diff --staged)と未処理のgit statusを確認します。 git add -Aで秘密情報や無関係な作業まで追加される可能性がある場合は、ファイルを明示的にステージします。- 適切な種類とスコープを選びます。
- 簡潔な件名を書き、変更内容が件名だけでは分からない場合は本文を追加します。
例
feat(auth): add OAuth2 login support
Implements Google and GitHub OAuth providers.
Closes #123
fix: resolve race condition in data fetcher
The previous implementation could return stale data
when multiple requests were in flight.
chore: update dependencies to latest versions
コメント
Markdown 対応