mcpField
C
commit-helper

commit-helper

github.com/zhaono1開発85701 回インストール9 週間前に更新
リポジトリ

commit-helper について

commit-helperは、Gitのコミットを作成する人向けのスキルです。Conventional Commitsに沿って、種類、スコープ、件名、本文、フッターを含むコミットメッセージの作成を支援します。

主な機能

  1. 01Conventional Commits形式への準拠
  2. 02変更種別とスコープの選択
  3. 03簡潔な命令形の件名作成
  4. 04説明本文と課題フッターの追加
  5. 05スクリプトによるメッセージ検証

活用シーン

  1. 01機能追加やバグ修正のコミットを整える
  2. 02破壊的変更や課題参照を記録する

インストール

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

$npx skills add https://github.com/zhaono1/agent-playbook --skill commit-helper

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

README.md
references/
conventional-commits.md
examples.md
scopes.md
scripts/
validate_commit.py

詳細

コミットメッセージヘルパー

Conventional Commits の仕様に沿って、適切な形式の Git コミットメッセージを作成するスキルです。

このスキルが有効になるとき

次のような場合に、このスキルが有効になります。

  • 変更のコミットを依頼したとき
  • コミットメッセージについて言及したとき
  • git commit の形式を依頼したとき
  • 「commit」または「git commit」と言ったとき

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

<type>(<scope>): <subject>

<body>

<footer>

種類

種類説明
feat新機能
fixバグ修正
docsドキュメントのみの変更
styleコードの意味に影響しない変更（フォーマットなど）
refactorバグ修正や機能追加を伴わないコード変更
perfパフォーマンスを向上させるコード変更
test不足しているテストの追加、または既存テストの修正
choreビルドプロセスまたは補助ツールの変更
ciCI 設定ファイルおよびスクリプトの変更
buildビルドシステムまたは外部依存関係に影響する変更

スコープ

スコープには、影響を受けるコードベースの領域を示します。

  • フロントエンドの場合：components、hooks、store、styles、utils
  • バックエンドの場合：api、models、services、database、auth
  • DevOps の場合：ci、deploy、docker
  • プロジェクト固有のスコープも使用できます

ガイドライン

件名
  • 命令形を使います（「added feature」や「adds feature」ではなく「add feature」）
  • 文末にピリオドを付けません
  • 最大 50 文字にします
  • 具体的かつ簡潔にします
本文
  • 件名と本文の間に空行を入れます
  • 本文では何を、なぜ行ったかを説明し、どのように行ったかは説明しません
  • 1 行あたり 72 文字で折り返します
  • 破壊的変更があれば記載します
フッター
  • Issue を参照します：Closes #123、Fixes #456、Refs #789
  • 複数の Issue の場合：Closes #123, #456, #789
  • 破壊的変更の場合：BREAKING CHANGE: で始め、その後に説明を記載します

例

良い例
feat(auth): add OAuth2 login support

Implement OAuth2 authentication flow to allow users to log in
with their Google or GitHub accounts.

This change adds:
- New OAuth2 middleware for handling callbacks
- Updated login UI with social login buttons
- User profile synchronization

Closes #123

fix(api): resolve race condition in user creation

The concurrent user creation requests could result in duplicate
email entries. Added unique constraint and proper error handling.

Fixes #456

refactor(user): simplify profile update logic

Extracted common validation logic into a reusable function
to reduce code duplication across profile update endpoints.

docs: update API documentation with new endpoints

Added documentation for the v2 user management endpoints
including request/response examples and error codes.
悪い例
updated stuff                    # Too vague, no type/scope
fixed bug                        # No context about which bug
feat: added feature              # Redundant ("feat" means new feature)
Feat(User): Add Login            # Incorrect capitalization
feat: A really really really long subject line that exceeds the recommended limit  # Too long

破壊的変更

破壊的変更を導入する場合は、フッターに BREAKING CHANGE: を追加します。

feat(api): migrate to REST v2

The API endpoints have been restructured for better consistency.
Old endpoints are deprecated and will be removed in v3.0.

BREAKING CHANGE: `/api/v1/users` is now `/api/v2/users`.
All consumers must update their integration by 2025-03-01.

ワークフロー

コミットメッセージを作成するときは、次の手順に従います。

  1. 変更を確認する - git diff を実行して変更内容を把握します
  2. 種類を特定する - 変更の種類を判断します
  3. スコープを特定する - 影響を受ける領域を判断します
  4. 件名を書く - 明確で簡潔な件名を作成します
  5. 本文を書く - 必要に応じて、何を、なぜ行ったかを説明します
  6. フッターを追加する - Issue を参照するか、破壊的変更を記載します

検証

検証スクリプトを使用して、コミットメッセージの形式を確認します。

python3 scripts/validate_commit.py "feat(scope): add behavior"

参考ドキュメント

  • 仕様の全文は references/conventional-commits.md を参照してください
  • さらに例を見るには references/examples.md を参照してください
  • 推奨されるスコープの命名については references/scopes.md を参照してください

コメント

Markdown 対応