docs(sdk-standards): update branch naming with username prefix and type descriptions#16667
Open
priscilawebdev wants to merge 9 commits intomasterfrom
Open
docs(sdk-standards): update branch naming with username prefix and type descriptions#16667priscilawebdev wants to merge 9 commits intomasterfrom
priscilawebdev wants to merge 9 commits intomasterfrom
Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
… branch prefix Co-Authored-By: Claude <noreply@anthropic.com>
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) | ||
|
|
There was a problem hiding this comment.
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.
…t section Co-Authored-By: Claude <noreply@anthropic.com>
…ection Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
…book Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
Co-Authored-By: Claude noreply@anthropic.com