Inspired by Mitchell Hashimoto's tweet:
I wish I could add a note to my branch on GitHub so people who viewed the branch could know why it exists. (Yeah, the README is one option)
I'd like to propose a unified BRANCH(.md)
file.
Github already treats Contributing Guidelines as a special case, so why not add a BRANCH.md
file.
This file would contain branch-specific information like:
This is Michael's branch from 1/3/2004. It's no longer in use and should not be used, but it is kept around for legacy purposes. This branch can be deleted when [email protected] is released.
Github should parse the BRANCH.md
and add a notification at the top of a branch (when selected) with the short description. Just a thought.
Granted, this means that the git user will have to deal with some merge conflicts, but I think it's worth it.