Skip to content

docs(sdk): Migrate Feature Flags spec to Writing SDK Specs guidelines - #20085

Draft
sentry-junior[bot] wants to merge 3 commits into
junior/writing-sdk-specs-skillfrom
junior/migrate-feature-flags-spec
Draft

sentry-junior[bot] wants to merge 3 commits into
junior/writing-sdk-specs-skillfrom
junior/migrate-feature-flags-spec

Conversation

@sentry-junior

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

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Migrates the Feature Flags spec to the Writing SDK Specs guidelines (#20081), using the writing-sdk-specs skill (#20083). This is the first trial run of that skill. The page is short, so the result is easy to check by hand.

What changed in the spec:

  • Requirements now describe only externally observable behavior. "Stored on the scope" and "hook into a third-party SDK" are rewritten as what you can see in sent events, spans, and the scope API. The hook pattern moved to Implementation Guidance.
  • Every requirement now uses an explicit bold keyword. Before, some obligations were lowercase "should" or plain statements ("we track the first 10…").
  • Requirement levels follow RFC 2119 Section 6. Exposing add_feature_flag and accepting string/boolean arguments are now "SHOULD", and API names can follow platform conventions. "MUST" is kept only for the wire formats Sentry reads (Feature Flag Context, flag.evaluation.<name> span attributes), for never recording non-boolean results, and for what clear_feature_flags does when an SDK exposes it.
  • The page follows the intro → Definitions → Requirements → Implementation Guidance → Changelog structure and declares spec_guidelines: writing-specs@0.1.

Because existing requirements changed, this is a major bump to 2.0.0, and every section's since is 2.0.0. Span attribute key and limits are taken from Span Data Conventions and the platform feature flag docs. SDK owners should confirm the new requirement levels 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 20, 2026 8:57am UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 20, 2026 8:57am UTC

Request Review

@github-actions github-actions Bot added the sdk-develop-docs PRs touching develop-docs/sdk label Oct 19, 2026
@sentry-junior
sentry-junior Bot added this pull request to stack #20084 October 19, 2026 15:34
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 19, 2026
Comment thread develop-docs/sdk/foundations/client/integrations/feature-flags.mdx Outdated
Comment thread develop-docs/sdk/foundations/client/integrations/feature-flags.mdx
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from a76ee7e to 5fcdc6e Compare October 19, 2026 15:56
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from 5fcdc6e to 3beef7d Compare October 19, 2026 16:10
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from 3beef7d to 3831b12 Compare October 19, 2026 16:33
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from 3831b12 to da32035 Compare October 19, 2026 16:35
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from da32035 to bfce223 Compare October 19, 2026 16:44
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from bfce223 to 1a931ce Compare October 19, 2026 16:51
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-feature-flags-spec branch from 1a931ce to c1ef0eb Compare October 19, 2026 17:05
@szokeasaurusrex

Copy link
Copy Markdown
Member

The spec writing guidelines were updated. Please check if this page needs any updates and apply them

List every requirement whose level or meaning changed in the 2.0.0
changelog entry, drop Implementation Guidance that describes an obvious
pattern, and remove the vague set_tag comparison.

This branch was successfully deployed

1 active deployment
Preview – develop-docs — 3a83de6f Deployed Oct 20, 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