Git branch descriptions

I often have quite a few branches open and although my branchList command has stood me in good sted for a long time now I would like to add notes or descriptions to a branch.

alias branchList='git for-each-ref --sort=committerdate refs/heads/ --format='\''%(HEAD) %(color:yellow)%(refname:short)%(color:reset) - %(color:red)%(objectname:short)%(color:reset) - %(content color:green)%(committerdate:relative)%(color:reset))'\'''



I don't really want to make the branch names overly long. I find that the commit messages aren't always good enough to tell me the purpose of the branch.

I guess this might just be bad practice on my part that the full information around why I created a branch cant be derived from the name and last commit message alone.


Recently I found out a way to add descriptions to branches so that I can add more information as to why I would be creating a branch and what the full scope of the work I was doing on that branch was.


This has lead to a new alias for me:

alias describebranch="git config branch.$(git rev-parse --abbrev-ref HEAD).description"


Obviously, I don’t type out describebranch when I want the description descr<tab> is sufficient.


To add the description to the current branch I simply:

Git branch --edit-description


I think I will find this mighty useful going forward.


It has also inspired me to find a better way to manage my git branches in the command line.

There are some extra tools I would like.

  • I would like a number based system to chose a branch from branchList.
  • I would like to be able to have an easy way to find the changes on a branch since it branched off of Master or any other branch for that matter.


https://stackoverflow.com/questions/1417957/show-just-the-current-branch-in-git

https://stackoverflow.com/questions/2108405/branch-descriptions-in-git

Comments

Post a Comment

Popular posts from this blog

An exploration in number systems

For most people, the denary system of numbers is perfectly natural. So much so that people don’t even give other options a second thought. The alternatives are not just hypothetical but are in their own way ingrained in our culture. What is the denary system of numbers? Denary from the Latin decem for ten, is a system of numbers where we have 10 symbols 0 to 9. For this, we use a positional number system based on powers of 10. Each column to the left has a value 10 times that to the right. The number 1000 is: Thousands Hundreds Tens units 1 0 0 0 This isn’t the only system that could be used and in fact, 10 is special only in the sense that we have 10 fingers. If the number of fingers isn’t taken into account then base 12 would make arithmetic a lot simpler. Instead of a 10s column you have a dozens, instead of 100s you have 144s. For this you ofcourse need more symbols. 10 is represented with the symbol A and 11 is represented with the symbol B. 12 is re
Read more

Structural engineering with cardboard

Image
Moving into a new flat I have ended up with a lot of cardboard and have actually struggled to get it to all be taken away. I then saw this Kickstarter on hacker news which introduced me to the idea that I could perhaps use the cardboard I had been throwing away the whole time. I have been toying with some ideas for building myself a robot, or at least a robot arm but they seem to be just ludicrously expensive and still not able to lift much weight. One of the problems with the advancement of robotics is that although processing power has come down in price at a rate that no other product ever has, the cost of actuators (The motion inducing components like motors) has remained largely the same. I want to explore an idea I have for using cheaper motors in a robotic arm in another post though. The problem I want to look at here is the possibility of being able to use cardboard, a material which can almost be considered to have a negative price, as the structure to the robot. I love the
Read more