From f507bb44a9bf3afb897a8615b01226aef76bee3d Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:28:55 +0100 Subject: [PATCH 1/9] docs(sdk-standards): update branch naming with username prefix and type 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 --- .../standards/code-submission.mdx | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 0b0e8d480f83f..004e1796a43e5 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 @@ -67,7 +70,23 @@ 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**: first word of `git config user.name`, lowercased, accents removed +- **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 +- **short-description**: kebab-case, 3–6 words #### 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 From 399651f9c0c9777984d6ad8a86a87e08131b7d22 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:34:09 +0100 Subject: [PATCH 2/9] docs(sdk-standards): use GitHub username instead of git user.name for branch prefix Co-Authored-By: Claude --- develop-docs/sdk/getting-started/standards/code-submission.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 004e1796a43e5..6b3390981960a 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -72,7 +72,7 @@ For additional context on commit message best practices, see [Commit Messages](/ `//` (e.g., `theo/feat/add-client-reports`, `alice/fix/rate-limit-parsing`). -- **username**: first word of `git config user.name`, lowercased, accents removed +- **username**: GitHub username (e.g., from `gh api user --jq .login`) - **type**: one of: - `feat` – New user-facing functionality - `fix` – Broken behavior now works From ecb4a658a41709d9dfaaaf5233b3e9a7909c2341 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:42:26 +0100 Subject: [PATCH 3/9] docs(sdk-standards): remove word limit from branch short-description Co-Authored-By: Claude --- develop-docs/sdk/getting-started/standards/code-submission.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 6b3390981960a..9ac191261964c 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -86,7 +86,7 @@ For additional context on commit message best practices, see [Commit Messages](/ - `chore` – Deps, config, version bumps, updating existing tooling — no new logic - `meta` – Repo metadata changes - `license` – License changes -- **short-description**: kebab-case, 3–6 words +- **short-description**: kebab-case #### Enforcement From ac1273a650a547597c1155452346036f5ff442c7 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:44:53 +0100 Subject: [PATCH 4/9] docs(sdk-standards): move type descriptions to commit message format section Define type descriptions once in 'Commit message format' and reference them from 'Branch naming' to avoid duplication. Co-Authored-By: Claude --- .../standards/code-submission.mdx | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 9ac191261964c..0db8556df1428 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -35,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. @@ -73,19 +85,7 @@ For additional context on commit message best practices, see [Commit Messages](/ `//` (e.g., `theo/feat/add-client-reports`, `alice/fix/rate-limit-parsing`). - **username**: GitHub username (e.g., from `gh api user --jq .login`) -- **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 +- **type**: same types as commit messages (see above) - **short-description**: kebab-case #### Enforcement From 5094e2ae18d11b99512cb86825d30fd4b8c8d97a Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:49:10 +0100 Subject: [PATCH 5/9] docs(sdk-standards): link branch naming types to commit message format section Co-Authored-By: Claude --- .../standards/code-submission.mdx | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 0db8556df1428..c54f68df4b887 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -35,19 +35,7 @@ sidebar_order: 2 **Header** (max 100 chars total): -- **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 +- **Type**: one of `feat`, `fix`, `ref`, `perf`, `docs`, `test`, `build`, `ci`, `chore`, `style`, `meta`, `license`. - **Subject**: imperative mood, capitalize first letter, no trailing period, max 70 chars **Body**: explain what and why, not how. @@ -85,7 +73,7 @@ For additional context on commit message best practices, see [Commit Messages](/ `//` (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 (see above) +- **type**: same types as [commit messages](#commit-message-format) - **short-description**: kebab-case #### Enforcement From 9fe5b3c7a3a73ec638920c04e5e2e624c753de14 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:49:30 +0100 Subject: [PATCH 6/9] docs(sdk-standards): add type descriptions to commit message format section Co-Authored-By: Claude --- .../getting-started/standards/code-submission.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index c54f68df4b887..99ca701bf2094 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -35,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. From 914f3897347eca956a2a0e7dd48a54174507113b Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:51:13 +0100 Subject: [PATCH 7/9] docs(sdk-standards): clarify short-description field in branch naming Co-Authored-By: Claude --- develop-docs/sdk/getting-started/standards/code-submission.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 99ca701bf2094..5a98d2ed8521c 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -86,7 +86,7 @@ For additional context on commit message best practices, see [Commit Messages](/ - **username**: GitHub username (e.g., from `gh api user --jq .login`) - **type**: same types as [commit messages](#commit-message-format) -- **short-description**: kebab-case +- **short-description**: short description of what changed, in kebab-case #### Enforcement From 84c93a61c12cf5738ca03229f828dc99a7a97155 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:53:34 +0100 Subject: [PATCH 8/9] docs(sdk-standards): improve short-description wording in branch naming Co-Authored-By: Claude --- develop-docs/sdk/getting-started/standards/code-submission.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/getting-started/standards/code-submission.mdx b/develop-docs/sdk/getting-started/standards/code-submission.mdx index 5a98d2ed8521c..df476e2a996c7 100644 --- a/develop-docs/sdk/getting-started/standards/code-submission.mdx +++ b/develop-docs/sdk/getting-started/standards/code-submission.mdx @@ -86,7 +86,7 @@ For additional context on commit message best practices, see [Commit Messages](/ - **username**: GitHub username (e.g., from `gh api user --jq .login`) - **type**: same types as [commit messages](#commit-message-format) -- **short-description**: short description of what changed, in kebab-case +- **short-description**: overview of the change, in kebab-case #### Enforcement From 4dbd5adf3c3273fa0aaa9eb7d7389227ed1a8d49 Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Wed, 4 Mar 2026 10:56:51 +0100 Subject: [PATCH 9/9] docs(sdk-playbooks): update branch naming format in opening-a-pr playbook Co-Authored-By: Claude --- .../getting-started/playbooks/development/opening-a-pr.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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