Skip to content

Instantly share code, notes, and snippets.

@ocxo

ocxo/Proposal.md

Created January 14, 2013 00:21
Show Gist options
  • Save ocxo/4526985 to your computer and use it in GitHub Desktop.
Save ocxo/4526985 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Proposal.md

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 my_app@1.0.0 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment