Find a compatible way to store and share branch descriptions to show it at the Github next (as well as at other apps and git itself).

[shapkarin]

Summary

• I wonder to see repository branches descriptions at the GitHub UI
• It can be present as a tooltip or additional section directly at the dropdown list of a branches inside a repo page https://github.com/{username}/{repo}. And of course at a repository branches page https://github.com/{username}/{repo}/branches
• I think to find a compatible a way to store and share such data
  • Ideally it should be compatible with Git, Github and other apps that based on Git source code management app
• GitHub is already use a list of special files and directories like README, LICENSE, CODEOWNERS, .github/ and other.
  • So I propose to reserve the special filename BRANCH_DESCRIPTION
    • But that approach is not compatible with the Git itself
• Git has branch description feature that can be used with command git branch --edit-description but it's not possible to share such data with collaborators because it's stored at the configuration file
• Git also has git notes that can be used to store a branch description as well
  • But it's pretty hard to share that data with collaborators

---

The first one proposal

At the release 1.7.9 Git was added a description to a branch. It can be defined by git branch --edit-description
Not sure if Github supports that but I think it may be useful to see a description for the branches.

• It can be present as a tooltip or additional section directly at the dropdown list of a branches inside a repo page https://github.com/{username}/{repo}.
• And of course at a repository branches page https://github.com/{username}/{repo}/branches

[shapkarin]

There is no way to share description created with git's --edit-description but maybe git notes can be used instead

Looks like it's not possible to push and share yours branch description with other people because it's stored in the git config file but pretty the same thing can be achieved with the git notes by command git notes add {namespace} -m "Some description" due they are saved to and read from refs/notes/{namespace} or refs/notes/commits and can be shown by git log along with the original commit message as the git docs mention.
So maybe git notes can be shown instead.
More info can be found at git notes docs and at that archived git docs (not sure if the last one are still actual)

[shapkarin]

Proposal to reserve the special filename BRANCH_DESCRIPTION

However just a some special Github file can be used to store and share branch descriptions, it can be located in the root or .github/ directory of the repository, in the branch where you'd like to add yours branch description. For example Github is already has some files like README, LICENSE, CODEOWNERS and etc.

It can be named BRANCH_DESCRIPTION and to be located in the root or .github/ directories, it can be branch specific file so if some branch has such file then it get the description that defined in that file.

---

PS: Maybe it's is possible to find a compatible way to to store and share branch descriptions for the Github and Git and other platforms, tools and apps.