📝 add code review guide for agents#141
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds agent-focused documentation to steer PR reviews toward electron-sdk-specific concerns (async correctness, observability/telemetry, bundler & packager coverage) and away from CI-enforced checks.
Changes:
- Added
docs/REVIEW.mdwith a focused code review checklist (async correctness, error handling,monitor()usage, compatibility, tests, bundler/packager scenarios, reuse guidance). - Added root
AGENTS.mdto direct AI agents to relevant docs before making/reviewing changes. - Updated
docs/README.mdto include the new review guide in the documentation index.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/REVIEW.md | Introduces electron-sdk-specific review guidance for agents (async/telemetry/bundler coverage emphasis). |
| docs/README.md | Adds the new review guide to the docs reference table. |
| AGENTS.md | Provides a short entry point for agents to read the docs index + review guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
We increasingly rely on AI agents to review PRs. This adds a concise guide to steer their feedback toward the electron-sdk-specific concerns that matter most (async correctness, SDK observability, bundler/packager coverage) and away from what CI already enforces.
Similar to what was done on the browser-sdk in DataDog/browser-sdk#4706, but tailored to the electron-sdk.
Changes
docs/REVIEW.md: electron-sdk-specific review guide covering async correctness, error handling philosophy, SDK observability (monitor()usage), backward compatibility, documentation, test quality, bundler/packager coverage, and reuse.AGENTS.mdat repo root: short instruction file pointing agents todocs/README.mdanddocs/REVIEW.mdbefore making or reviewing changes (read by Codex and Copilot Coding Agent)..github/copilot-instructions.md: condensed version of the review guide for GitHub Copilot code review (which cannot follow file references), with an added review process section (regression detection, git history check, architectural flow, PR scoring).docs/README.mdto reference the new file.Test instructions
Documentation-only change, no runtime impact. Review
docs/REVIEW.mdand.github/copilot-instructions.mdfor accuracy and tone.Checklist