日本語

简体中文
English

日本語

简体中文
English

コミットメッセージの生成 ​

ステージ済みの Git 変更に基づき、説明的なコミットメッセージを自動生成します。VJSP はステージされたファイルを分析し、ベストプラクティスに従った Conventional Commits 形式のコミットメッセージを作成します。

ⓘ 注意

この機能はステージ済みの変更のみを分析します。コミットメッセージを生成する前に、git add コマンドまたは IDE のインターフェースを使ってファイルを必ずステージしてください。

動作の仕組み ​

Git コミットメッセージ生成機能は以下の処理を行います：

  • ステージ済みの変更のみを分析（ステージされていないファイルや未追跡ファイルは無視されます）
  • AI を使って変更のコンテキストと目的を理解
  • 「何が」「なぜ」変更されたかを説明する記述的なコミットメッセージを生成し、デフォルトで Conventional Commits 仕様に準拠

機能の使用方法 ​

コミットメッセージの生成 ​

  1. git add コマンドまたは IDE の Git インターフェースを使って変更をステージします
  2. IDE のソースコントロールパネルで、コミットメッセージ入力欄の横にある VJSP ロゴを探します
  3. ロゴをクリックしてコミットメッセージを生成します

生成されたメッセージはコミットメッセージ欄に表示され、必要に応じて確認・編集できます。

Conventional Commits 形式 ​

デフォルトでは、生成されるメッセージは Conventional Commits 仕様に従います：

<type>(<scope>): <description>
<body>

よく使われる type には以下があります：

  • feat: 新機能の追加
  • fix: バグ修正
  • docs: ドキュメントの変更
  • style: コードスタイルの変更（フォーマットなど）
  • refactor: コードのリファクタリング
  • test: テストの追加または更新
  • chore: メンテナンスタスク

設定 ​

カスタムコミットテンプレート ​

プロンプトテンプレートを編集することで、コミットメッセージの生成方法をカスタマイズできます：

  1. 歯車アイコン ⚙️ をクリックして Settings → Prompts を開きます
  2. 「Commit Message Generation」セクションを見つけます
  3. プロンプトテンプレートをプロジェクトの規約に合わせて編集します

デフォルトテンプレートは Conventional Commits を生成しますが、以下のようにカスタマイズ可能です：

  • 異なるコミットメッセージ形式を使用
  • プロジェクト固有の情報を含める
  • チームのコミットメッセージガイドラインを強制
  • AI へのカスタム指示を追加

API 設定 ​

コミットメッセージ生成に使用する API プロファイルを設定できます：

  1. Prompts 設定画面で「API Configuration」までスクロールします
  2. 特定のプロファイルを選択するか、現在選択中のものを使用します

💡 ヒント

コミットメッセージ生成専用に、より高速でコスト効率の良いモデルを使用するための専用 API 設定プロファイル を作成することを検討してください。

ベストプラクティス ​

ステージ戦略 ​

  • 関連する変更をまとめてステージし、一貫性のあるコミットメッセージを生成
  • 関係のない変更を単一のコミットに混在させない
  • 必要に応じて git add -p を使ってファイルの一部だけをステージ

メッセージのレビュー ​

  • コミット前に必ず生成されたメッセージを確認
  • AI が見落とした可能性のあるコンテキストを手動で追加
  • メッセージが変更内容を正確に記述していることを確認

カスタムテンプレート ​

  • プロンプトテンプレートをプロジェクトのニーズに合わせて調整
  • プロジェクト固有の用語や規約を含める
  • 特定の種類の変更に対する処理方法に関する指示を追加

生成例 ​

以下はこの機能が生成する可能性のあるメッセージの例です：

feat(auth): Google との OAuth2 統合を追加

Google OAuth2 認証フローを実装：
- OAuth2 クライアント設定
- ユーザープロフィール取得
- トークン更新メカニズム
fix(api): ユーザーデータ取得時の競合状態を解決

データ不整合を引き起こす並行リクエストを防ぐために、
適切なエラーハンドリングとリトライロジックを追加
docs(readme): インストール手順を更新

新規貢献者のために、不足していた依存関係要件を追加し、
セットアップ手順を明確化

トラブルシューティング ​

ステージ済み変更がない ​

ボタンが表示されない、または生成に失敗する場合は、変更がステージされているか確認してください：

git add <files>
# またはすべての変更をステージ
git add .

メッセージの品質が低い ​

生成されたメッセージが役に立たない場合：

  • ステージ戦略を見直し、関係のない変更をまとめない
  • プロンプトテンプレートにさらに具体的な指示を追加
  • API 設定から別の AI モデルを試す

統合に関する問題 ​

この機能は IDE の組み込み Git 機能と連携しています。問題が発生した場合は：

  • リポジトリが正しく初期化されていることを確認
  • IDE が Git リポジトリにアクセスできることを確認
  • Git がインストールされており、IDE から利用可能であることを確認

関連機能 ​