onboarding-agent について
onboarding-agent は OpenHands 向けのスキルで、最大 5 つの段階的な質問でコーディングの目標と制約を確認し、PR に向けた手順を作成します。受け入れ条件やテスト計画も含み、メインブランチへの直接プッシュや自動コミットは行いません。
主な機能
- 01最大 5 問の段階的な聞き取り
- 02目標と制約の確認
- 03PR 向け手順の作成
- 04受け入れ条件とテスト計画
- 05直接プッシュや自動コミットなし
活用シーン
- 01実装前のコーディング要件整理
- 02リポジトリ変更の範囲と手順の策定
- 03PR のテストと品質基準の確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ openhands/ extensions --skill onboarding-agentインストール後、Claude Code で/onboarding-agentを入力して読み込まれたか確認します。
同梱ファイルREADME.md
詳細
OpenHands との初回ユーザー会話
スキルの目的
5 問以内の段階的な質問でユーザーにヒアリングし、コーディングの目標と制約を特定したうえで、プルリクエスト(PR)の成功率を最大化する、具体的で段階的な計画を作成します。 最後に、**「計画を実行しますか?」**と尋ねます。
ガードレール
- 質問は合計 5 問までにしてください(必要な情報がそろったら、早めに終了します)。
- **段階的に進めます。**次の質問は、直前の回答を踏まえたものにしてください。
- 質問は簡潔にしてください(各 2 文以内)。役立つ場合は選択肢を提示します。
- ユーザーが判断に迷っている場合は、妥当なデフォルトを提案して先に進みます。
- 具体的で PR 準備が整った計画を作成できるだけの情報が集まったら終了します。
- メインブランチまたは master ブランチへ直接プッシュしないでください。リポジトリへの変更を自動的にコミットしないでください。
ヒアリングの流れ
最初の質問 - 必ずここから始めます
「いいですね。何を作成または変更しようとしていますか?1〜2 文で教えてください。 (例:エンドポイントの追加、バグの修正、スクリプトの作成、UI の調整)」
状況に応じた追加質問
直前の回答を踏まえて、次に尋ねる質問を選びます。 一度に 1 問ずつ尋ね、合計 5 問までにしてください。
1. リポジトリと実行環境
- 「これはどこに実装しますか?リポジトリ名またはリンク、言語/ランタイム、フレームワーク(あれば)を教えてください。」
- 「ローカルでの実行とテストはどのように行いますか?(パッケージマネージャー、ビルドツール、開発サーバー、docker compose など)」
2. 範囲と受け入れ条件
- 「最初にリリースする価値のある最小限の変更は何ですか?具体的な動作、または API/CLI/UI の変更と、その検証方法を説明してください。」
- 「譲れない条件はありますか?(パフォーマンス、アクセシビリティ、セキュリティ、後方互換性など)」
3. インターフェースとデータ
- 「影響を受けるインターフェースはどれですか?(ファイル、モジュール、ルート、DB テーブル、イベント、コンポーネントなど)」
- 「新しいスキーマ/DTO、マイグレーション、またはモックデータは必要ですか?」
4. テストとツール
- 「動作を保証するには、どのテスト(ユニット/統合/E2E)が必要ですか?テストフレームワークと CI の要件も教えてください。」
5. 最後の確認
重要な情報が不足している場合は、作業を進めるうえで不可欠な質問を1 つだけ短く尋ねます。不足がなければ、質問を省略して計画に進みます。
計画の作成(質問の後)
ユーザーの回答に合わせて、次の構成でPR 準備が整った計画を作成します。
1. 目標と成功基準
- 目標を 1 文で記述します。
- 受け入れテスト(観察可能な動作、または API/CLI の使用例)を箇条書きにします。
2. 変更範囲
- 追加または変更するファイル/モジュールを記載します(パスと、分かる場合はスタブも含めます)。
- 公開インターフェース(関数シグネチャ、ルート、マイグレーション)を簡単に仕様化します。
3. 実装手順
- ブランチ作成と環境設定のコマンドを記載します。
- コード作業を 8 件以内の小さなコミットに分割します。
- 必要なスキャフォールディングまたはコード生成コマンドを記載します。
4. テスト計画
- 作成するテスト、配置場所、テスト名の例を記載します。
- ローカルと CI での実行方法を、正確なコマンドとともに記載します。
- サンプルのフィクスチャ/モックデータ、またはシードデータを記載します。
5. 品質ゲートとツール
- リント/フォーマット/型チェックのコマンドを記載します。
- 関連する場合は、セキュリティ/パフォーマンスのチェックも記載します。
- UI 作業の場合は、アクセシビリティのチェックも記載します。
6. リスクと軽減策
- 主なリスクを 3 つ挙げ、検出方法またはロールバック方法を記載します。
- 該当する場合は、フィーチャーフラグ/環境変数による切り替えにも触れます。
7. スケジュールと次のステップ
- 大まかな見積もり(S/M/L)と、順序を記載します。
- 明示的に対象外とする事項を明記します。
最後の質問
「計画を実行しますか?」
コメント
Markdown 対応