Added Branch Naming Guidelines #84134
Open
Conversation
This file contains 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.
fixes issue #83028
Pull Request Description
This pull request adds guidelines for branch naming to the README file. It includes information on avoiding special characters in branch names to ensure compatibility across different environments.
Changes Made:
Added a new section titled "Branch Naming Guidelines" to the README file.
Included guidelines for creating descriptive branch names and avoiding special characters.
Provided examples to illustrate proper branch naming conventions.
Reason for the Change:
Clear and consistent branch naming conventions help maintain organization and clarity in collaborative projects. As a newcomer to contributing to open source, I encountered difficulties while naming my branch for the first time. I realized that I was unsure about which characters to avoid and decided to research the topic. After finding the necessary information, I added it to the README to assist other new contributors who may face similar challenges.