diff --git a/develop-docs/sdk/getting-started/playbooks/development/opening-a-pr.mdx b/develop-docs/sdk/getting-started/playbooks/development/opening-a-pr.mdx index dbc02e77e3d09..70142c4e6ecaa 100644 --- a/develop-docs/sdk/getting-started/playbooks/development/opening-a-pr.mdx +++ b/develop-docs/sdk/getting-started/playbooks/development/opening-a-pr.mdx @@ -37,9 +37,9 @@ Related resources: #### 1. Branch from the default branch -You **MUST** use the naming convention `/` ([Branch naming](/sdk/getting-started/standards/code-submission#branch-naming)). +You **MUST** use the naming convention `//` ([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 diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 0b0e8d480f83f..df476e2a996c7 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -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 @@ -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. @@ -67,7 +82,11 @@ For additional context on commit message best practices, see [Commit Messages](/ #### Rule -`/` (e.g., `feat/add-client-reports`, `fix/rate-limit-parsing`). +`//` (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 @@ -75,7 +94,7 @@ For additional context on commit message best practices, see [Commit Messages](/ #### 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