Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
priscilawebdev wants to merge 9 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f507bb4
docs(sdk-standards): update branch naming with username prefix and ty…
priscilawebdev Mar 4, 2026
399651f
docs(sdk-standards): use GitHub username instead of git user.name for…
priscilawebdev Mar 4, 2026
ecb4a65
docs(sdk-standards): remove word limit from branch short-description
priscilawebdev Mar 4, 2026
ac1273a
docs(sdk-standards): move type descriptions to commit message format …
priscilawebdev Mar 4, 2026
5094e2a
docs(sdk-standards): link branch naming types to commit message forma…
priscilawebdev Mar 4, 2026
9fe5b3c
docs(sdk-standards): add type descriptions to commit message format s…
priscilawebdev Mar 4, 2026
914f389
docs(sdk-standards): clarify short-description field in branch naming
priscilawebdev Mar 4, 2026
84c93a6
docs(sdk-standards): improve short-description wording in branch naming
priscilawebdev Mar 4, 2026
4dbd5ad
docs(sdk-playbooks): update branch naming format in opening-a-pr play…
priscilawebdev Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions develop-docs/sdk/getting-started/playbooks/development/opening-a-pr.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Related resources:

#### 1. Branch from the default branch

You **MUST** use the naming convention `<type>/<short-description>` ([Branch naming](/sdk/getting-started/standards/code-submission#branch-naming)).
You **MUST** use the naming convention `<username>/<type>/<short-description>` ([Branch naming](/sdk/getting-started/standards/code-submission#branch-naming)).

Examples: `feat/add-user-auth`, `fix/rate-limit-parsing`.
Examples: `theo/feat/add-user-auth`, `alice/fix/rate-limit-parsing`.

#### 2. Confirm a linked issue exists

Expand Down
27 changes: 23 additions & 4 deletions develop-docs/sdk/getting-started/standards/code-submission.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
---
title: Code Submission
spec_id: sdk/getting-started/standards/code-submission
spec_version: 1.0.0
spec_version: 1.1.0
spec_status: candidate
spec_platforms:
- all
spec_changelog:
- version: 1.1.0
date: 2026-03-04
summary: Add username prefix and type descriptions to branch naming
- version: 1.0.0
date: 2026-02-18
summary: Initial Code Submission standard
Expand All @@ -32,7 +35,19 @@ sidebar_order: 2

**Header** (max 100 chars total):

- **Type**: one of `feat`, `fix`, `ref`, `perf`, `docs`, `test`, `build`, `ci`, `chore`, `style`, `meta`, `license`.
- **Type**: one of:
- `feat` – New user-facing functionality
- `fix` – Broken behavior now works
- `ref` – Same behavior, different structure
- `perf` – Same behavior, faster
- `style` – CSS, formatting, visual-only
- `docs` – Documentation only
- `test` – Tests only
- `ci` – CI/CD config
- `build` – Build system
- `chore` – Deps, config, version bumps, updating existing tooling — no new logic
- `meta` – Repo metadata changes
- `license` – License changes
- **Subject**: imperative mood, capitalize first letter, no trailing period, max 70 chars

**Body**: explain what and why, not how.
Expand Down Expand Up @@ -67,15 +82,19 @@ For additional context on commit message best practices, see [Commit Messages](/

#### Rule

`<type>/<short-description>` (e.g., `feat/add-client-reports`, `fix/rate-limit-parsing`).
`<username>/<type>/<short-description>` (e.g., `theo/feat/add-client-reports`, `alice/fix/rate-limit-parsing`).

- **username**: GitHub username (e.g., from `gh api user --jq .login`)
- **type**: same types as [commit messages](#commit-message-format)
- **short-description**: overview of the change, in kebab-case

#### Enforcement

- CI advisory (non-blocking)

Copy link

@sentry sentry bot Mar 4, 2026

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.

#### Suggested skill(s)

- [`sentry-skills:commit`](https://github.com/getsentry/skills#available-skills)
- [`sentry-skills:create-branch`](https://github.com/getsentry/skills#available-skills)

#### Per-SDK override

Expand Down
Loading