Git branch naming conventions

343 views
Skip to first unread message

Kamal Gill

unread,
Sep 9, 2013, 5:30:05 PM9/9/13
to tea...@eucalyptus.com
Team,

There seems to be some inconsistency in how we're naming our branches. Now that we're on a distinct GitHub repo, we can probably avoid prefixing our branches with "team/console/*" branches.

For Jira tickets that are labelled with Type = "Bug", how 'bout we go with bugfix/EUCA-*,
and features would be feature/EUCA-* ?

Not sure how we should name research spikes. Perhaps research/EUCA-* ? or spike/EUCA-* ?)

I don't have strong preferences for these names, but we should settle on a standard.

Thoughts?

Cheers,
Kamal

--
Kamal Gill
Software Engineer
Eucalyptus Systems
www.eucalyptus.com

Garrett Holmstrom

unread,
Sep 9, 2013, 6:12:47 PM9/9/13
to team-ui
On Mon, Sep 9, 2013 at 2:30 PM, Kamal Gill <kamal...@eucalyptus.com> wrote:
> There seems to be some inconsistency in how we're naming our branches. Now that we're on a distinct GitHub repo, we can probably avoid prefixing our branches with "team/console/*" branches.
>
> For Jira tickets that are labelled with Type = "Bug", how 'bout we go with bugfix/EUCA-*,
> and features would be feature/EUCA-* ?
>
> Not sure how we should name research spikes. Perhaps research/EUCA-* ? or spike/EUCA-* ?)
>
> I don't have strong preferences for these names, but we should settle on a standard.

I added x/y/z branch categorization to the eucalyptus project only for
access control. The eucalyptus-console project doesn't have that
problem, so I suggest just using plain issue IDs or descriptive names
as appropriate. What practical advantage does including categories in
branch names provide to the project? It seems like they're generally
focused on specific issue IDs anyway.

--
Garrett Holmstrom
Eucalyptus Systems Release Engineering

David Kavanagh

unread,
Sep 9, 2013, 6:27:56 PM9/9/13
to team-ui

+1 I don't think special prefixes adds anything when the issue contains the vital details.

--
You received this message because you are subscribed to the Google Groups "team-ui" group.
To unsubscribe from this group and stop receiving emails from it, send an email to team-ui+u...@eucalyptus.com.
To post to this group, send email to tea...@eucalyptus.com.
To view this discussion on the web visit https://groups.google.com/a/eucalyptus.com/d/msgid/team-ui/CAAMXtoDdSnhL1nGnqW6th9Yo8kMSJCE%3D9WRz3_UjGkY57xXbQg%40mail.gmail.com.
For more options, visit https://groups.google.com/a/eucalyptus.com/groups/opt_out.

Kamal Gill

unread,
Sep 9, 2013, 6:27:53 PM9/9/13
to tea...@eucalyptus.com
What practical advantage does including categories in
branch names provide to the project?  It seems like they're generally
focused on specific issue IDs anyway.

Good question!  Prefixing by category allows bucketing of the branches in tools such as SourceTree, which would show the bugfix branches in a bugfix "folder", for example.  Screenshot attached.

--Kamal


--
Kamal Gill
Software Engineer
Eucalyptus Systems
www.eucalyptus.com



Garrett Holmstrom

unread,
Sep 9, 2013, 6:41:47 PM9/9/13
to team-ui
On Mon, Sep 9, 2013 at 3:27 PM, Kamal Gill <kamal...@eucalyptus.com> wrote:
>
> What practical advantage does including categories in
> branch names provide to the project? It seems like they're generally
> focused on specific issue IDs anyway.
>
>
> Good question! Prefixing by category allows bucketing of the branches in tools such as SourceTree, which would show the bugfix branches in a bugfix "folder", for example. Screenshot attached.

That's great, but what how is that useful? Now I have to dig through
folders to find the branch for issue EUCA-abcd.

Kamal Gill

unread,
Sep 9, 2013, 6:50:27 PM9/9/13
to tea...@eucalyptus.com
Maybe it's out of habit that I'm advocating prefixed branch names, since nearly all git-based projects I've worked on followed the branching model at http://nvie.com/posts/a-successful-git-branching-model/ .

But I'm not married to the prefixes and, since our feature/bugfix branches are short-lived anyway, I'm fine with naming the branch EUCA-**** per se if that's what the team prefers.

Cheers,
Kamal

--
Kamal Gill
Software Engineer
Eucalyptus Systems
www.eucalyptus.com



> --
> You received this message because you are subscribed to the Google Groups "team-ui" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to team-ui+u...@eucalyptus.com.
> To post to this group, send email to tea...@eucalyptus.com.
> To view this discussion on the web visit https://groups.google.com/a/eucalyptus.com/d/msgid/team-ui/CAAMXtoAHsijVR3xmbVKX79E32TyK6wvJQtU6E%3D9%3DD7Sh36kj9Q%40mail.gmail.com.

Ean Schuessler

unread,
Sep 9, 2013, 7:16:43 PM9/9/13
to tea...@eucalyptus.com
I think if we are going to have a prefix it should be a single one (issues/EUCA-XXXX) vs multiples (bugs/EUCA-XXXX, features/EUCA-XXXX). Inevitably, someone will classify a new feature as a bug, the branch will get created and then the record will get flipped from bug to feature in JIRA, leaving people grasping for the branch or even creating a new, competing one.


David Kavanagh

unread,
Sep 9, 2013, 7:19:59 PM9/9/13
to team-ui
I side on the idea of a single prefix, or none at all (because at that point...) only because of the redundancy and the chance for error that allows. Being a VI guy, the less I have to type, the better. :-)





--

_________________________

 

David Kavanagh - Software Engineer

Eucalyptus Systems

www.eucalyptus.com

_________________________

Garrett Holmstrom

unread,
Sep 9, 2013, 7:32:49 PM9/9/13
to team-ui
On Mon, Sep 9, 2013 at 3:50 PM, Kamal Gill <kamal...@eucalyptus.com> wrote:
> Maybe it's out of habit that I'm advocating prefixed branch names, since nearly all git-based projects I've worked on followed the branching model at http://nvie.com/posts/a-successful-git-branching-model/ .

That's possible. The git-flow workflow doesn't work particularly well
for heavyweight projects like eucalyptus that have long-lived
maintenance branches as opposed to short-lived maintenance branches
that immediately disappear, so things weren't organized that way. But
who knows? Maybe that will change.

I will echo the others here and suggest that if you go with a prefix
for issues, use only one of them. Things tend to change their
categories quite frequently around here.
Reply all
Reply to author
Forward
0 new messages