Skip to content

docs(sdk): Migrate Modules spec to Writing SDK Specs guidelines - #20089

Draft
sentry-junior[bot] wants to merge 8 commits into
junior/writing-sdk-specs-skillfrom
junior/migrate-modules-spec
Draft

sentry-junior[bot] wants to merge 8 commits into
junior/writing-sdk-specs-skillfrom
junior/migrate-modules-spec

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Migrates the Modules spec to the Writing SDK Specs guidelines (#20081), using the writing-sdk-specs skill. Stacked on #20083.

Requirement changes, for review:

  • Removed: "MUST use the processEvent lifecycle hook". It's an implementation detail. The observable result (modules on events) is still required.
  • Removed: "SHOULD cache the module list". Moved to Implementation Guidance.
  • Removed: "SHOULD use the most reliable mechanism", "MAY combine multiple sources", and "the more specific version SHOULD take precedence". These are replaced by one outcome requirement: the modules field SHOULD list every module installed in the application's environment or loaded by the application, each with the version the application uses. The discovery strategies and the precedence tip moved to Implementation Guidance.
  • Level changed: attaching modules to events goes from "MUST" (implied by the processEvent and event.modules requirements) to "SHOULD". The format (a map from module name to version string in the modules field) stays "MUST", since that's what Sentry reads.
  • Meaning narrowed: "MAY skip modules on certain event types where they are less useful" now reads "MAY omit modules from events that are not error events, such as transactions". "Less useful" left it open whether skipping error events conforms. The new wording rules that out.
  • Unchanged: "SHOULD be a default integration", moved into Event Enrichment.

The page now has a Scope section (it applies to SDKs that implement the Modules integration) and defines "module", following the Structure and Clarity rules. The JSON snippet and the Node.js/Python init examples were removed because they only restated requirements. The page declares spec_guidelines: writing-specs@0.1. Since existing requirements changed, this is a major bump to 2.0.0, and every section's since is 2.0.0, matching #20085.

SDK owners should confirm the "MUST" → "SHOULD" change and the narrowed "MAY" before this leaves draft.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • 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

via @szokeasaurusrex.

--

View Junior Session [Sentry]

@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 19, 2026 5:13pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 19, 2026 5:13pm UTC

Request Review

sentry-junior Bot and others added 5 commits October 19, 2026 17:05
Repo-local skill that points agents at the Writing SDK Specs page,
has them check their own changes against it, and report pre-existing
violations without fixing them. Listed in AGENTS.md and SKILL.md.

Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Move the skill from .claude/skills/ to .agents/skills/ and declare it in
agents.toml with a path: source, matching the dotagents convention for
repo-local skills. Keep a .claude/skills symlink like the existing ones.

Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
The root SKILL.md is a routing guide, not how skills are discovered.
AGENTS.md already lists the skill.

Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
@sentry-junior
sentry-junior Bot force-pushed the junior/writing-sdk-specs-skill branch from 8a84e4d to 7020ce6 Compare October 19, 2026 17:05
sentry-junior Bot and others added 3 commits October 19, 2026 17:09
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
Preview – develop-docs — c183f098 Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant