docs: enhance submission guidelines for error fixes in telemetry

This commit is contained in:
Bryan Chen
2026-03-17 10:08:34 -07:00
parent e660fad21e
commit 3182751ba8

View File

@@ -15,3 +15,23 @@ Follow the `fix-errors` skill guidelines to fix this error. Key principles:
4. **If the producer is identifiable**, fix it directly.
After making changes, check for compilation errors via the build task and run relevant unit tests.
## Submitting the Fix
After the fix is validated (compilation clean, tests pass):
1. **Create a branch**: `git checkout -b <github-username>/<short-description>` (e.g., `bryanchen-d/fix-notebook-index-error`).
2. **Commit**: Stage changed files and commit with a message like `fix: <brief description> (#<issue-number>)`.
3. **Push**: `git push -u origin <branch-name>`.
4. **Create a draft PR** with a description that includes:
- A summary of the change.
- What scenarios may trigger the error.
- The code flow explaining why the error gets thrown and goes unhandled.
- Steps a user can follow to manually validate the fix.
- How the fix addresses the issue, with a brief note per changed file.
5. **Monitor the PR** for Copilot review comments. Wait 1-2 minutes after each push for Copilot to leave its review, then check for new comments. Evaluate each comment:
- If valid, apply the fix, amend the commit, and force-push.
- If not applicable, leave a reply explaining why.
- After addressing comments, update the PR description if the changes affect the summary, code flow explanation, or per-file notes.
6. **Repeat monitoring** after each force-push: wait 1-2 minutes, check for new Copilot comments, and address them. Continue this loop until no new comments appear.
7. **Re-run tests** after addressing review comments to confirm nothing regressed.