Skip to content

Comments

docs(sdk): migrate reviewing-ai-generated-code playbook to spec format#16501

Merged
stephanie-anderson merged 2 commits intomasterfrom
dev-docs/playbooks/reviewing-ai-generated-code
Feb 23, 2026
Merged

docs(sdk): migrate reviewing-ai-generated-code playbook to spec format#16501
stephanie-anderson merged 2 commits intomasterfrom
dev-docs/playbooks/reviewing-ai-generated-code

Conversation

@dingsdax
Copy link
Contributor

@dingsdax dingsdax commented Feb 21, 2026

DESCRIBE YOUR PR

Migrates the reviewing-ai-generated-code playbook to the standardized spec format. Changes applied:

  • Added spec frontmatter with version 1.0.0, candidate status
  • Added SpecRfcAlert, SpecMeta, and SpecChangelog components
  • Added Overview section with related resources
  • Applied RFC 2119 keywords (MUST, MUST NOT, SHOULD) to all requirements
  • Enhanced skill references with proper links to sentry-skills
  • Expanded Referenced Standards section with 5 standards and descriptions
  • Structured into "Standard review first" and "Additional AI-specific checks" sections
  • Used @sdk-leads terminology consistently
  • Verified all referenced standard sections exist

The playbook extends standard code review with AI-specific checks for hallucinated imports, meaningless tests, over-engineering, speculative changes, and subtle behavior changes.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Co-Authored-By: Claude noreply@anthropic.com

- Added spec frontmatter with version tracking
- Added SpecRfcAlert, SpecMeta, and SpecChangelog components
- Added Overview section with related resources
- Applied RFC 2119 keywords to requirements
- Enhanced skill references with proper links
- Expanded Referenced Standards section with 5 standards
- Structured into standard review and AI-specific checks sections
- Used @sdk-leads terminology consistently
- Verified all referenced standard sections exist

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Feb 23, 2026 8:32am
sentry-docs Ready Ready Preview, Comment Feb 23, 2026 8:32am

Request Review

@stephanie-anderson stephanie-anderson merged commit 3b7530e into master Feb 23, 2026
15 checks passed
@stephanie-anderson stephanie-anderson deleted the dev-docs/playbooks/reviewing-ai-generated-code branch February 23, 2026 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants