Zenn
😊

Claude-devの自動Gitコミットカスタムインストラクション

2024/09/16に公開
Git
Claude
カスタムインストラクション
claudedev
tech

🌟 はじめに

開発者の皆さん、AIを活用してコーディングの効率を劇的に向上させる方法をお探しですか？Claude-devのカスタムインストラクションが、あなたの開発ワークフローを一新します。この記事では、Claude-devに設定できるカスタムインストラクションの内容と、その活用方法を詳しく解説します。

🔍 Claude-devのカスタムインストラクションとは？

Claude-devのカスタムインストラクションは、AIアシスタントの動作を特定のタスクに最適化するための指示セットです。特に注目すべきは、ファイル変更時の自動コミット生成に関する指示です。これにより、以下のような機能が実現されます：

  1. 日本語対応: すべての応答を日本語で行います。
  2. 自動コミット提案: ファイルの変更を検知し、コミットを提案します。
  3. 絵文字付きコミットメッセージ: 可読性の高い、ユニークな絵文字付きのコミットメッセージを作成します。
  4. Gitflowに基づいたブランチ戦略: 効果的なバージョン管理を支援します。
# システムコマンド

- 日本語で応答すること。
- ファイルの変更があった場合、都度コミットを行うこと。
- Gitのコミットメッセージには以下の要素を含めること：
  1. 先頭にカラフルでユニークな絵文字を付与し、可読性を向上させる。
  2. 日本語でコミットメッセージを作成する。
  3. 変更内容が分かるように、タイトルと概要を記載する。
  4. 必要であればブランチを作成して提案する。

# Gitコミットルール（Gitflow概念に基づく）

1. ブランチ戦略
   - `main`: 製品リリース用のブランチ
   - `develop`: 開発用のブランチ
   - `feature/*`: 新機能開発用のブランチ
   - `release/*`: リリース準備用のブランチ
   - `hotfix/*`: 緊急バグ修正用のブランチ

2. コミットメッセージ形式
    ```bash
    <絵文字> <タイプ>: <タイトル>

    <本文>

    <フッター>
    ```

3. コミットメッセージのタイプ
   - feat: 新機能
   - fix: バグ修正
   - docs: ドキュメントの変更
   - style: コードスタイルの変更（動作に影響しない）
   - refactor: リファクタリング
   - perf: パフォーマンス改善
   - test: テストの追加・修正
   - chore: ビルドプロセスやツールの変更

4. 注意点
   - 主要な変更とその目的に焦点を当てる。
   - 変更を明確かつ簡潔に説明する。
   - 見やすさを重視し、必要に応じて箇条書きを使用する。
   - 同じ絵文字の多用を避ける。
   - 必要に応じて、少数のファイルごとに別ブランチを提案する。
   - Stageの差分を注意深く確認し、追加・削除された機能を正確に把握する。

5. コミットメッセージの出力
   - 指定されたフォーマットに従い、タイトルと本文を含める。
   - 不要な情報は出力しない。

6. コミットのタイミング
   - ファイルの変更があった場合、都度コミットを行う。
   - 複数のファイルが同時に変更された場合、関連する変更をまとめて1つのコミットとすることも検討する。

💡 カスタムインストラクションの主要機能

1. コミット提案の自動化

ファイルの変更があるたびに、AIがコミットの提案を自動的に生成します。これにより、細かな変更も逃さず記録できます。

2. コミットメッセージの最適化

各コミットメッセージは以下の要素を含むよう指示されています：

  • カラフルでユニークな絵文字
  • 日本語での明確な説明
  • 変更内容を示すタイトルと概要

3. ブランチ管理の提案

必要に応じて新しいブランチの作成を提案し、Gitflowに基づいた効果的なブランチ戦略を支援します。

4. コミットタイプの分類

コミットの内容に応じて、以下のようなタイプを自動的に分類するよう指示されています：

  • feat: 新機能
  • fix: バグ修正
  • docs: ドキュメントの変更
  • style: コードスタイルの変更
  • refactor: リファクタリング
  • perf: パフォーマンス改善
  • test: テストの追加・修正
  • chore: ビルドプロセスやツールの変更

🚀 カスタムインストラクションの活用方法

  1. VSCodeでClaude-dev拡張機能をインストールします。
  2. 拡張機能の設定からカスタムインストラクションを入力します。
  3. 新しいプロジェクトを開始するか、既存のプロジェクトを開きます。
  4. ファイルの編集を行います。
  5. Claude-devが自動的に変更を検知し、コミットを提案します。
  6. 提案されたコミットメッセージを確認し、必要に応じて編集します。
  7. コミットを承認し、変更を記録します。

💻 カスタムインストラクション使用例

以下は、設定したカスタムインストラクションに基づいてClaude-devが生成するコミットメッセージの例です：

✨ feat: ユーザー認証機能の実装

- ログイン画面のUIを作成
- パスワードのハッシュ化処理を追加
- JWTを使用したトークン発行機能を実装

このようなコミットメッセージにより、変更の目的と内容が一目で分かり、チーム内のコミュニケーションが円滑になります。

🌈 カスタムインストラクションがもたらす利点

  1. 時間の節約: コミットメッセージ作成の手間が大幅に削減され、開発に集中できます。
  2. 一貫性の維持: 統一されたフォーマットでコミットメッセージが作成されるため、プロジェクト全体で一貫性が保たれます。
  3. 可読性の向上: 絵文字と明確な構造により、コミット履歴が読みやすくなります。
  4. チームコラボレーションの促進: 詳細なコミットメッセージにより、チームメンバー間の情報共有が容易になります。
  5. コードレビューの効率化: 変更内容が明確なため、レビュープロセスが迅速化します。

🔧 カスタムインストラクションの調整

Claude-devのカスタムインストラクションは、あなたのニーズに合わせて調整できます。以下のような要素を変更することで、より適切な動作を実現できます：

  • 使用する絵文字のセット
  • コミットメッセージの言語（日本語/英語）
  • ブランチ命名規則
  • コミットメッセージの構造

これらの設定を調整することで、あなたやチームのワークフローに最適化したAIアシスタントを実現できます。

📚 まとめ

Claude-devのカスタムインストラクションは、AIの力を活用して開発プロセスを革新します。自動コミット提案、最適化されたコミットメッセージ、そして効果的なブランチ管理により、開発者は本質的なコーディング作業に集中できます。このカスタマイズ可能な設定を活用することで、個人やチームの生産性を大幅に向上させることができるでしょう。

Claude-devを導入して、カスタマイズされたAIアシスタントとともに次世代の開発体験を始めましょう！

リポジトリ

https://github.com/Sunwood-ai-labs/MysticLibrary/blob/main/prompts/coding/claude-dev-system-promt.md

<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

Discussion