Repository navigation
docs(sdk): Add Writing SDK Specs page and legacy spec notice - #20081
Draft
sentry-junior[bot] wants to merge 8 commits into
Draft
sentry-junior[bot] wants to merge 8 commits into
sentry-junior[bot] wants to merge 8 commits into
Conversation
Add a meta-spec for writing SDK specs: requirements only describe externally observable behavior, follow RFC 2119 Section 6, and default to SHOULD. Specs opt in with spec_guidelines frontmatter; SpecMeta shows a legacy notice on every spec that does not declare it. Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
github-actions
Bot
added
sdk-develop-docs
1 of 6 tasks
Display the spec_guidelines value in SpecMeta, add a spec_kind: process field for playbooks and engineering standards so they are out of scope for Writing SDK Specs and show no legacy notice, and narrow the spec's scope accordingly. 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>
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
…gration notes to guidance
1 of 6 tasks
…ent rule Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
This branch was successfully deployed
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
1 participant
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.
Adds a Writing SDK Specs page (
writing-specs.mdx). Many of our SDK specs dictate implementation details, overuse MUST, and are hard to follow. This page sets the rules for writing them: requirements cover only externally observable behavior, and MUST is used sparingly.Existing specs aren't rewritten here. The spec header (
specMeta.tsx) marks pages that don't follow the guidelines yet as legacy, so we can migrate them one at a time. Most of the touched files are a one-linespec_kind: processfrontmatter change. It keeps playbooks and team standards out of scope, because they aren't SDK specs.via @szokeasaurusrex.
--
View Junior Session [Sentry]