docs(repo): Add branch naming guidance#3701
Open
buenaflor wants to merge 1 commit into
Open
Conversation
Document the preferred branch name format so contributors use a consistent username/type/description structure. Co-Authored-By: GPT-5.5 <noreply@openai.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Semver Impact of This PR⚪ None (no version bump detected) 📋 Changelog PreviewThis is how your changes will appear in the changelog. This PR will not appear in the changelog. 🤖 This preview updates automatically when you update the PR. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a brief Branch Naming section to CONTRIBUTING.md describing the git-username/type/short-description convention for contributor branches.
Changes:
- New "Branch Naming" section between the analyzer and changelog sections.
- Specifies allowed
typevalues (feat, fix, docs, test, chore) and short-description style. - Provides an illustrative example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Document the preferred branch naming format for contributors.
This adds a short
git-username/type/short-descriptionconvention near the existing contributor workflow docs so branch names stay consistent without adding extra process.Made with Cursor