mcpField
C
commit-workflow

commit-workflow

github.com/fcakyon開発1.2k45 回インストール今日更新
リポジトリ

commit-workflow について

プロジェクトの規約に沿ったコミット作成を支援するスキルです。ステージ済み変更の確認、メッセージ作成、READMEの更新を案内します。

主な機能

  1. 01ステージ済みファイルと差分の確認
  2. 02簡潔なコミットメッセージの作成
  3. 03READMEの更新要否の確認
  4. 04コミットメッセージ形式の検証

活用シーン

  1. 01ステージ済み変更のコミット準備
  2. 02コミットメッセージの統一
  3. 03コード変更に伴うドキュメント更新

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/fcakyon/claude-codex-settings --skill commit-workflow

インストール後、Claude Code で/commit-workflowを入力して読み込まれたか確認します。

詳細

コミットのワークフロー

プロジェクトの規約に沿ってコミットを作成するための完全なワークフローです。

手順

  1. commit-creator エージェントを使用する

    • 自動でコミットを処理するには、/commit-staged [context] を実行します
    • または、以下の手動手順に従います

  2. ステージされたファイルのみを分析する

    • ステージされたファイルをすべて確認します：git diff --cached --name-only
    • 差分を読みます：git diff --cached
    • ステージされていない変更は完全に無視します

  3. コミットメッセージの形式

    • 1 行目：{type}: brief description（最大 50 文字）
    • タイプ：feat、fix、refactor、docs、style、test、build
    • 「何を」ではなく「なぜ」に焦点を当てます
    • 可能であれば、従来の形式に沿った 1 文と、動機や発見事項を伝える 1 文にします
    • 複雑な変更の場合は、空行の後に箇条書きを追加します

  4. メッセージの例

    • feat: implement user authentication system
    • fix: resolve memory leak in data processing pipeline
    • refactor: restructure API handlers to align with project architecture

  5. ドキュメントの更新

    • README.md を確認し、以下をチェックします：
      • ドキュメントに記載すべき新機能
      • 実装と一致しなくなった古い説明
      • 新しい依存関係に必要なセットアップ手順の不足
    • ステージされた変更に応じて、必要な更新を行います

  6. 実行

    • コミットでは、適切な形式にするため HEREDOC 構文を使用します
    • コミットメッセージの形式が正しいことを確認します
    • コミットメッセージにテスト計画を追加しないでください

ベストプラクティス

  • メッセージを書く前に、ステージされたファイルを分析します
  • 1 行目は 50 文字未満にします
  • メッセージには能動態を使います
  • 役立つ場合は関連コードを参照します
  • 1 つのコミットにつき、論理的な変更を 1 つにします
  • README に実装が反映されていることを確認します

コメント

Markdown 対応