BRANCH.md

Guide to naming a 🌳 branch

• 🎈 Why is it important to write good branch names?
• ✏️ How to name a branch
• 🌺 Examples
  • Example 1
  • Example 2

🎈 Why is it important to write good branch names?

If you name your branches properly, it will be easier for you and others to find them.

✏️ How to name a branch

• Use username/change format: Use your GitHub username, followed by a slash (/), followed by a short description of the change. For example, nazmulidris/add-section-to-style-guide.
• Use a descriptive name: If possible use a name similar to the title of the issue you are working on.

🌺 Examples

Example 1

nazmulidris/add-section-to-style-guide

Breaking down the branch name:

• nazmulidris: GitHub username.
• add-section-to-style-guide: This is the descriptive name with the issue number.

Example 2

nazmulidris/201-add-section-to-style-guide

Breaking down the branch name:

• nazmulidris: GitHub username.
• 201: This is the issue number.
• add-section-to-style-guide: This is a short descriptive name.