Skip to content

DO NOT MERGE - docs(sdk): standards and playbooks#16399

Closed
stephanie-anderson wants to merge 7 commits intomasterfrom
docs/add-sdk-standards-and-playbooks
Closed

DO NOT MERGE - docs(sdk): standards and playbooks#16399
stephanie-anderson wants to merge 7 commits intomasterfrom
docs/add-sdk-standards-and-playbooks

Conversation

@stephanie-anderson
Copy link
Contributor

DESCRIBE YOUR PR

Add enforceable SDK standards and step-by-step playbooks to the Getting Started section of the SDK develop-docs.

Standards (7 categories):

  • Planning & Scoping, Code Submission, Code Quality, API & Architecture, Review & CI, Repository & Documentation, Coordination & Maintenance
  • Each standard defines the rule, enforcement mechanism, suggested skills, and per-SDK override policy

Playbooks (12 workflows):

  • Opening a PR, reviewing a PR, reviewing AI-generated code, cutting a release, handling a regression, deprecating an API, dropping platform support, adding a dependency, cross-SDK rollout, handling external contributor PRs, setting up a new SDK repo, quarterly retro

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • 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

Add enforceable SDK standards covering planning, code submission, code
quality, API architecture, review/CI, repository docs, and coordination.
Add step-by-step playbooks for common workflows like opening PRs,
handling regressions, and reviewing AI-generated code. Update the
Getting Started index to link both sections.

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

vercel bot commented Feb 17, 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 18, 2026 9:47am
sentry-docs Ready Ready Preview, Comment Feb 18, 2026 9:47am

Request Review


#### Rule

Every PR must include a description with: what the PR does, why these changes are being made, links to relevant issues or tickets (required for non-trivial changes; typo and one-line doc fixes exempt), alternative approaches considered (if any), additional context reviewers need. No test plan sections, no checkbox lists, no boilerplate. The tests in the diff are the test plan. Blank descriptions, template-only descriptions, and AI-generated filler are not acceptable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Every PR must include a description with: what the PR does, why these changes are being made, links to relevant issues or tickets (required for non-trivial changes; typo and one-line doc fixes exempt), alternative approaches considered (if any), additional context reviewers need. No test plan sections, no checkbox lists, no boilerplate. The tests in the diff are the test plan. Blank descriptions, template-only descriptions, and AI-generated filler are not acceptable.
Every PR must include a description with: what the PR does, why these changes are being made, links to relevant issues or tickets (required for non-trivial changes; typo and one-line doc fixes exempt), alternative approaches considered (if any), additional context reviewers need. No test plan sections, no checkbox lists, no boilerplate. The tests in the diff are the test plan. Blank descriptions, template-only descriptions, and AI-generated filler are not acceptable. PR descriptions must not include any customer data or sensitive information.

@stephanie-anderson stephanie-anderson changed the title docs(sdk): Add standards and playbooks to Getting Started DO NOT MERGE - docs(sdk): Add standards and playbooks to Getting Started Feb 18, 2026
@stephanie-anderson stephanie-anderson changed the title DO NOT MERGE - docs(sdk): Add standards and playbooks to Getting Started DO NOT MERGE - docs(sdk): standards and playbooks Feb 18, 2026
stephanie-anderson added a commit that referenced this pull request Feb 19, 2026
Migrates `develop-docs/sdk/processes/releases.mdx` into the new
playbook/standard structure from #16399:

- **New standard** (`release-versioning.mdx`): version format,
pre-release identifiers, build identifiers, release tooling, merge
target, CalVer, multiple craft configs
- **New playbook** (`setting-up-release-infrastructure.mdx`):
step-by-step guide for getting a repo release-ready
- Adds redirect from old `/sdk/processes/releases/` path
- Replaces stale `uwsgi-dogstatsd-plugin` example links with
`sentry-python`

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Johannes Daxböck <114897+dingsdax@users.noreply.github.com>
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
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

Comments