Skip to content

docs(sdk): Expand project setup and close-out guidance in Linear playbook#17861

Draft
christophaigner wants to merge 7 commits into
masterfrom
christophaigner/docs/project-issue-template-improvements
Draft

docs(sdk): Expand project setup and close-out guidance in Linear playbook#17861
christophaigner wants to merge 7 commits into
masterfrom
christophaigner/docs/project-issue-template-improvements

Conversation

@christophaigner
Copy link
Copy Markdown
Member

@christophaigner christophaigner commented May 22, 2026

DESCRIBE YOUR PR

Preview is here.

Expands the Managing Linear Projects playbook with more prescriptive guidance on project setup and close-out.

Changes:

  • Project fields: split into MUST (title, initiative, lead, status, target date, team, description, resources) / SHOULD (customers, milestones)
  • Project description template: replaced the prose description with a copyable markdown template with inline comment prompts (summary, customer-facing changes, why, expected outcomes, in/out of scope, dependencies, risks, DoD)
  • Closing Out — Artifact Checklist: bullet list of artifacts to verify before closing (public docs, develop docs, sentry-conventions, sentry-wizard, Sentry CLI, public samples, in-product prompts, dashboards)
  • Closing Out — Communication Checklist: marketing, Vanguard, blog posts, changelog
  • Closing Out — Follow-Up: post-launch performance check and GA promotion (scoped to user-facing features)
  • planning-scoping.mdx: added a cross-reference from the project-level DoD to the new artifact checklist

Once merged, we can also add a Linear project template for it.

IS YOUR CHANGE URGENT?

  • None: 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

Made with Cursor

…book

Add a structured project description template with copyable markdown,
split required project fields into MUST/SHOULD/MAY tiers, and expand
the Closing Out section with an artifact checklist, communication
checklist, and follow-up reminders. Also add a cross-reference from
the planning-scoping DoD standard to the new artifact checklist.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment May 26, 2026 2:34pm
sentry-docs Ready Ready Preview, Comment May 26, 2026 2:34pm

Request Review

- Write a [Sentry Product Blog](https://blog.sentry.io/) post
- Write a [Sentry Changelog](https://sentry.io/changelog/) entry
- Write a [Sentry Engineering Blog](https://sentry.engineering/blog) post
- Write an [internal blog post](https://vanguard.getsentry.net/)
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Add S&T

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Also integrate into list above - split into sections "Project-specific" vs. "General"

@christophaigner
Copy link
Copy Markdown
Member Author

Additionally, every project may have RFC, DACI, PRFAQ, etc.


## User-facing changes
<!-- What will developers/users be able to do differently after this ships? -->
-
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Suggested change
-

@christophaigner
Copy link
Copy Markdown
Member Author

MUST vs. should

@christophaigner
Copy link
Copy Markdown
Member Author

Link to RFCs: https://github.com/getsentry/rfcs

christophaigner and others added 5 commits May 26, 2026 16:14
The dash placeholders inside the markdown code block were being rendered
as list items on the page, breaking the visual appearance of the template.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Move artifact and communication checklists from a separate Closing Out
section into the project description template as grouped sub-sections
(Have we updated / Have you thought about / follow-up issues). Update
the cross-reference in planning-scoping.mdx accordingly.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant