バグを修正する
根本原因を見つけなさい。症状を一時的にごまかしてはいけません。アプリケーションかライブラリかは問いません。
このスキルは、修正がグリーンになった後で、かつユーザーがそれを選択したか、すでに証明を依頼している場合にのみ prove-it を読み込みます。CopilotKit のデバッグスキルを上書きしません。
使用するタイミング
障害が発生している場合に読み込んでください:テスト失敗、赤い CI、予期しない結果、スタックトレース、またはユーザーが「壊れている」「直して」と言った場合。
失敗を伴わないグリーンフィールド機能はスキップしてください。ドキュメントや型のみの編集もスキップします。
厳格なゲート
- ログから原因が特定されるまで修正しないでください。 「いくつか試してみる」は禁止です。
- ホットパス上に 少なくとも3つの仮説を立ててください。それぞれ異なる場所(自関数、呼び出し元、依存関係)からです。
- 仮説を置いたすべてのパスの前後にデバッグログを追加してください。サードパーティパッケージにデバッグモードがある場合は、この調査のためにオンにしてください。
- 原因を特定したら、このスキルが追加したすべてのログを削除し、サードパーティのデバッグをオフにしてください。 その後、失敗するテストを書き、修正してください。ログは修正に残してはいけません。
- グリーンにするために失敗テストをスキップ、削除、無効化しないでください。エラーを飲み込まないでください(
|| true、空の catch)。レースコンディションを隠すためにタイムアウトを長くしないでください。 - 根本原因を修正し、さらにそのファイル/近傍モジュールにある同じパターンも修正してください。余分なリファクタリングは禁止です。
- ユーザーが選択するか、すでにこの修正の証明を依頼していない限り、
prove-itを読み込まないでください。 テストスイートがグリーンであることは証明ではありません。デフォルトはスキップです。
ホットパス
失敗するテスト(またはユーザーの操作)からエラー行までのスタックをたどり、さらにそこで呼び出される関数と呼び出す関数も含みます。
そこから始めてください。排除していく。 絞り込む。そのパス上のすべての仮説が否定された場合のみ範囲を広げてください。
手順
手順 1: 読む
- エラー、スタックトレース、CI ログの全文を読んでください。すべての行を。
- 失敗テストがある場合は、その本文を読んでください。
- そのバグを導入したと思われる差分があれば、それを読んでください。
- まだ編集しないでください。
手順 2: 仮説
- ホットパス(ファイルと関数)をマッピングしてください。
- 少なくとも3つの仮説を書いてください:「エラーは X が原因で、なぜなら Y だから。」それらはホットパス全体にわたっていなければなりません(同じ行に対する3つの推測ではありません)。
- 3つ書けない場合は、十分に読んでいないということです。手順 1 に戻ってください。
手順 3: 計測
- 仮説に登場するサードパーティパッケージごとに、そのドキュメントでデバッグフラグや環境変数を確認してください。存在すればオンにします。
- 仮説を置いた各ブランチの前後に一時的なログを追加してください(入力、出力)。リポジトリの既存のロガーか
consoleを使用してください。ロギングパッケージを追加しないでください。 - 一度再現してください。ログを読んでください。ログによって否定された仮説に**×をつけて**ください。
- すべての仮説が否定された場合、ホットパスを1ステップ広げてください(次の呼び出し元か次の依存関係)。新しい仮説、新しいログ。再度排除してください。
- 原因が特定されたら:このスキルが追加したすべてのログを削除してください。 サードパーティのデバッグをオフにしてください。ワーキングツリーにそれらのログが残っていないことを確認してください。
手順 4: 失敗テスト、次に修正
- このバグが原因で失敗するテストを書いてください(赤)。独立した期待値を使用してください。このステップをスキップしないでください。
- 実行してください。指定した理由で失敗しなければなりません。
- 根本原因のみを修正してください。また、そのファイル/近傍モジュールで同じ間違いのコピーがあれば修正してください。
- そのテストを実行してください(グリーン)。次に、このパッケージ/ファイルのスイートの既存のテストを実行してください。
- 新しい失敗が発生した場合、それを新しいバグとして扱ってください。手順 1 からやり直してください。新しい破損の上に最初の修正を出荷しないでください。
手順 5: オプションの証明 (prove-it)
- このパッケージのスイートがグリーンになり、ログがなくなったら、1回だけ尋ねてください。 選択肢:
prove-itを読み込む、またはスキップ。デフォルトはスキップです。 - 待ってください。ユーザーが選択するまで
prove-itを読み込まないでください。 - ユーザーがこの会話の中で既にこの修正の証明を依頼している場合は、尋ねるのをスキップしてください。
prove-itを読み込んでください。 - スキップの場合: 修正はユーザーパスとして証明されていないと伝えてください。グリーンスイートを証明として扱わないでください。手順 6 へ。
- ユーザーが
prove-itを選択した場合:prove-itを読み込んでそれに従ってください。その後、手順 6 へ。 - このスキル内でアプリをクリックしたり、API に curl したり、証明レポートを書いたりしないでください。その作業は
prove-itの担当です。
手順 6: 停止
スキップ後、または prove-it が戻ったら、停止してください。
決定木
- 障害が発生中 → 手順 1 → 2 → 3 → 4 → 5 → 6。
- 再現不可 → 停止。「再現できません」と伝え、手順を尋ねてください。推測で修正しないでください。
- ログがすべてのホットパス仮説を否定 → 範囲を広げ、手順 2 からやり直し。
- 修正後もテストが赤のまま → 原因が間違っています。修正を元に戻し、手順 2 に戻ってください。
- 次の関数に同じパターンがある → この同じ変更で修正してください(厳格なゲート 6)。
- スイートはグリーン、まだ証明の依頼なし → 手順 5(尋ねる、デフォルトスキップ)。
- ユーザーが既にこの修正の証明を依頼している →
prove-itを読み込み、その後手順 6。
レッドフラグ
| シグナル | 意味 | 代わりに行うこと |
|---|---|---|
| 仮説1つでパッチ | 推測 | 手順 2。ホットパス上で3つ。 |
| ログなしの修正 | 排除なし | 手順 3。 |
差分にデバッグ console.log が残っている | ログ未削除 | 手順 3 のステップ 5。その後テスト。 |
サードパーティの DEBUG=* がオンになったまま | ハントフラグが出荷された | ログと一緒にオフにする。 |
.skip / 失敗テストの削除 | 症状のごまかし | コードを修正する。 |
|| true / 空の catch | エラーを飲み込む | 原因を説明するか修正する。 |
| より長いタイムアウト | 隠されたレースコンディション | レースコンディションを修正する。 |
| 修正中のリファクタリング | ついで | 根本原因 + 同じパターンのみ。 |
| モノレポ全体のテスト実行 | 依頼なし | このパッケージ / このスイートのみ。 |
| 「自分のマシンでは動く」 | 異なる環境 | 失敗と同じコマンド / 同じ条件で。 |
依頼なしで prove-it を読み込む | 依頼されていない証明 | 手順 5。デフォルトスキップ。 |
| このスキル内でのミニブラウザ通過 | prove-it の重複 | ユーザーが選択した後に prove-it を読み込む。 |
| 「テストが通ったので証明された」 | グリーンスイートを証明として扱う | 手順 5。スキップは証明されていないことを意味する。 |
エラーハンドリング
- 再現不可: その旨を伝えてください。実行した内容をリストアップしてください。修正をでっち上げないでください。
- 依存関係にデバッグモードがない: そのステップはスキップしてください。それでもホットパス上の自コードにはログを残してください。
- ログが膨大: ファイルのすべての行ではなく、仮説を置いたブランチのみにログを追加してください。
- 失敗テストがまだ書けない(テストハーネスがない): バグをアサートする1ファイルのスクリプトを代用として使用してください。それでも赤、次に修正、そしてグリーン。
- 修正によって別のテストが失敗する: その失敗に対して手順 1 を実行してください。カスケードが解決されるまで最初の修正をプッシュしないでください。
prove-itがこのエージェントにない: その旨を伝えてください。スキップを提案してください。ここで2つ目の証明手順をでっち上げないでください。- ユーザーが
prove-itを選んだ後、その中でスキップした: 修正は証明されていません。手順 6。
このスキルはヘルパーを配置したりドキュメントを書いたりしません。証明は手順 5 のみです。