Skip to content

docs(sdk-standards): update branch naming with username prefix and type descriptions#16667

Open
priscilawebdev wants to merge 9 commits intomasterfrom
priscila/docs/update-branch-naming-standard
Open

docs(sdk-standards): update branch naming with username prefix and type descriptions#16667
priscilawebdev wants to merge 9 commits intomasterfrom
priscila/docs/update-branch-naming-standard

Conversation

@priscilawebdev
Copy link
Member

@priscilawebdev priscilawebdev commented Mar 4, 2026

DESCRIBE YOUR PR

Aligns the branch naming standard with getsentry/skills#71 by adding a username prefix and documenting commit types.

IS YOUR CHANGE URGENT?

  • 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

…pe descriptions

Add username prefix to branch naming convention per getsentry/skills#71,
expand type list with descriptions, bump spec to 1.1.0.

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

vercel bot commented Mar 4, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 4, 2026 10:03am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Mar 4, 2026 10:03am

Request Review

… branch prefix

Co-Authored-By: Claude <noreply@anthropic.com>
priscilawebdev and others added 2 commits March 4, 2026 10:42
Co-Authored-By: Claude <noreply@anthropic.com>
…section

Define type descriptions once in 'Commit message format' and reference
them from 'Branch naming' to avoid duplication.

Co-Authored-By: Claude <noreply@anthropic.com>
#### Enforcement

- CI advisory (non-blocking)

Copy link

Choose a reason for hiding this comment

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

Bug: The opening-a-pr.mdx playbook provides an outdated branch naming format, contradicting the newly updated code-submission.mdx standard it references.
Severity: CRITICAL

Suggested Fix

Update the opening-a-pr.mdx file to reflect the new branch naming standard. Specifically, change the instructions and examples in "Step 1" to match the <username>/<type>/<short-description> format documented in code-submission.mdx.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: develop-docs/sdk/getting-started/standards/code-submission.mdx#L75

Potential issue: The `code-submission.mdx` file was updated to specify a new branch
naming standard of `<username>/<type>/<short-description>`. However, the
`opening-a-pr.mdx` playbook, which guides developers on creating pull requests and links
to the standard, was not updated. It still instructs users to follow the old
`<type>/<short-description>` format. This will cause developers following the playbook
to create non-compliant branches, leading to user confusion and potential CI validation
failures. The playbook's content is inconsistent with the standard it claims to follow.

Did we get this right? 👍 / 👎 to inform future reviews.

priscilawebdev and others added 5 commits March 4, 2026 10:49
…t section

Co-Authored-By: Claude <noreply@anthropic.com>
…ection

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
…book

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant