It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

What branch name conventions do you use?

What, if any, conventions do you apply to the naming of branches in order to create notional groups of branches? I'm trying to validate a hypothesis to help shape a plugin idea.

This is a question for users of Stash; but StashDev might as well chip in, although I already have some idea of how you work. :-)

Do you, for example, name branches to reflect the release you intend them to be part of? Do you name them according to the software component or feature they apply to? Something else?

7 answers

1 accepted

10 votes
Answer accepted
jhinch Atlassian Team Nov 04, 2012

Hi David,

I find that there are 2 main naming convention styles within git. Hyphen separated or slash separated. GitFlow uses the latter to separate groups of branches:

e.g.

hotfixes/ANERD-9999
releases/2.1
features/totality-search

Many of the cross product teams within Atlassian use this convention. Product teams within Atlassian seem to use the hyphen approach:

e.g.

release-4.5.x
ANERD-3333-project-visualisation
1.3-ANERD-2020-ie8-fixes

I find a lot of Git experts like to use the slashes approach as it equates to directories organising branches on the filesystem

Git flow standards:

 

 - master

 - develop

 - feature/XXX (encourage JIRA issue key)

 - release/XXX (encourage JIRA issue key if applicable, e.g., a Deploy ticket, or a single feature)

 - hotfix/XXX (encourage JIRA issue key)

4 votes

I know that the Confluence team has adopted the following approach and follows an "Issue/Story driven development" workflow:

Short lived branches are created for every issue/story using the following naming convention:

issue/JIRA-ISSUE-KEY

or

issue/JIRA-ISSUE-KEY-short-summary

Hth,

Stefan

We have a centralized/non-forking workflow.

We encourage developers to push their in-work features to the centralized repo. We enforce feature branches pushed to the server follow the standard of: <username>/<branchname>. We recommend the branch be named as the issue ID, but that is not part of our process.

We do not differentiate between hotfix, bugfix or feature.

We do not use master past the first commit. It makes the initial clone faster.

Releases each have their own short uniquely named branch without a slash. We try to keep these names to 6 characters or less.

For our development/code review/pull request branches we are using a scheme of

DEV-(username)-(Jira issue key)-(optional desc/keyword)

0 votes
Deleted user Oct 27, 2017

We work on a mercurial repo, branch-per-version, branch-per-issue and development on default.

Versions are semver, vMajor.minor.patch.
Issue branches are Jira codes.

All the standards mentioned in above answers are all time best standards to follow for branching in GIT. We always prefer the creation of branch name includes some sprint name and JIRA no. 

We use the following conventions for creating branches while working with Agile JIRA sprint mode.

i.e. 

  • Sprint Master Branch - <PROJECT_SHORT_NAME><SPRINT_NO.> - e.g. MCS40
  • Sprint Dev Branch - <PROJECT_SHORT_NAME><SPRINT_NO.>_<JIRA_NO> - e.g. MCS40_MM-7387
  • Sprint Release Branch - Release_<PROJECT_SHORT_NAME><SPRINT_NO.>_<SUB_PROJECT_SHORT_NAME>_<VERSION_OF_RELEASE> - e.g. Release_MCS40_MM_1.2.5
  • Hotfix Branch - e.g. Hotfix_MCS40_MM-7400

 

I hope it will help someone.

Thanks.




Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Training & Certification

Introducing Atlassian University Live!

Atlassian University is committed to providing the best training and certification for Atlassian products through on-demand classes, in-person team training, a world-class certification program, and ...

369 views 11 19
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you