How to organize your git branches
Darío Kondratiuk Sep 17
I remember implementing git in my team. I think it was more than 6 years ago. At that time, A successful git branching model by Vincent Driessen was required reading if you wanted to learn how to work with git effectively. Since then, I've been following the "Git Flow" style. But, this past year, I've been influenced by many developers from the community, and started using git in different ways depending on the projects I was working on.
Before getting into the different branching styles, it's important to remember that, although many git clients treat slashes ("/") as a directory separator, there is no such thing as folders or directories in the git specification. You will see this implemented in many UI clients, but I never found it on console clients, or on websites like Github or GitLab.
That being said, Let's explore some ways of organizing branches, so you don't get lost in a sea of code.
Although Gitflow doesn't mention branch folders, many devs use "Feature branches", "Hotfix branches" and "Release branches" and create folders accordingly.
So basically, a GitFlow organization would have these three folders:
As there is no public document talking about this, I've seen some working copies using those folders in plural and others in singular.
Gitflow with steroids
I found myself adding two more folders to my Gitflow repos:
- Docs: For branches related to markdown or release documents.
- Task: For branches which are neither features nor fixes. Such as, clean up scripts or refactors.
I’ve seen this a lot in many projects. The branch-push-merge-prune is the anti-folder method. I'm not saying that chaos is a way of organizing branches. People using this method like to have their working copy clean. They would just branch, push, create a pull request and then delete the branch (manually or via git fetch prune) as soon as the PR is merged.
I found myself using what I call a "module-based" branching model on a big project where I got quite lost in a sea of features and fixes. So I started to create branches based on its modules.
You could mix Gitflow with this module-based approach, something like "backoffice/billing/fixes/billing-values", but that may be too much.
I first saw Meir using this approach and I loved it. It’s great for projects like Puppeteer-sharp where the roadmap is clear.
In a version-based repo you create each branch inside a "vX.X" folder. What is cool about this is that it’s time-based, so it's easier to find branches and also it's super easy to delete old versions with this simple git command:
git branch | grep -e "vX.X/" | xargs git branch -D
Again, this could be mixed with Gitflow folders, but...
If tickets numbers (tickets, issues or whatever you call them) are part of your team's language using a ticket-based system could be a perfect fit.
You could use a folder, such as "tickets/242" or "issues/242", or just simply call it "242".
If none of these systems is for you, you can follow Nick's idea and implement an Emoji-based system :)
Two final thoughts to close this post. First, if you work on a team where you normally checkout each other branches, e.g. for local testing, I'd recommend you share the style with your team.
And finally, clean your working copy frequently. This will help you find your branches quickly, and also speed up your local repo.
Don't stop coding!
Originally posted on harkoded.com