Skip to content

dmaru9/conventional-commit

v1.0.1

Conventional Commits 1.0.0 に準拠したコミットを作成する共通スキル。複数プロジェクトで使い回すためのプラグイン化版。

GitHub

Conventional Commit Skill

Conventional Commits 1.0.0 に準拠したコミットを作成するスキルです。

概要

コミットメッセージの作成、変更内容の確認、コミット実行までを支援します。日本語で記述し、簡潔で統一されたコミット履歴を維持できます。

コミットメッセージの構造

<type>[scope]: <description>

[本文(任意)]

[フッター(任意)]

Type 一覧

Type用途例
feat新機能の追加feat: ログイン機能を追加
fixバグ修正fix: ログアウト時のエラーを修正
docsドキュメントの変更のみdocs: READMEのセットアップ手順を更新
styleコードの意味に影響しない変更style: インデントを修正
refactorリファクタリングrefactor: ユーザー取得処理を関数化
perfパフォーマンス改善perf: データベースクエリを最適化
testテストの追加・修正test: ログイン機能のテストを追加
buildビルドシステムや依存関係の変更build: TypeScriptのバージョンを更新
ciCI 設定の変更ci: GitHub Actionsのワークフローを修正
choreその他の変更chore: 未使用のファイルを削除
revertコミットの取り消しrevert: "feat: ..." を取り消し

Scope（任意）

変更の範囲を括弧で指定します。

feat(auth): パスワードリセット機能を追加
fix(api): ユーザー削除のエンドポイントを修正

破壊的変更

既存の機能に影響する変更は ! またはフッターで明示します。

feat!: APIのレスポンス形式を変更

BREAKING CHANGE: レスポンスの構造が変わったため、クライアント側の修正が必要

使用方法

VS Code の Copilot チャットで以下のように依頼します：

「変更をコミットしてください」
「この変更をfixとしてコミットして」

手順

  1. 変更内容の把握 — git status / git diff で差分を確認
  2. Type と Scope の決定 — 変更内容に合った Type を選択
  3. ファイルのステージング — git add で対象ファイルをステージング
  4. コミットメッセージの作成 — フォーマットに従い作成
  5. Issue/PR フッターの付与（任意） — ブランチ名から #数字 を抽出しフッターに追記
  6. コミットの実行 — git commit で実行
  7. 確認 — git log -1 で内容を確認

記述ルール

  • 言語: 日本語で記述する
  • 絵文字: 使用しない
  • 句点: 1行目の末尾に句点（。）を付けない
  • 文体: 簡潔に記述する（「〜を追加」「〜を修正」など）

前提条件

  • Git がインストール済みであること