what should be in the git description file?

After initialising a new local repo there is a description file present.

What is it used for and how should I format it? Or is it simply a local helper file.

  • How can I bring a terribly old branch up to speed with the main one?
  • Will git-rm --cached delete another user's working tree files when they pull
  • Git pretty format colors
  • How to know the release version for a commit in android source?
  • Git and Amazon RDS Mysql source control
  • Git: Is it possible to fake the signing date of a tag?
  • This thread Accessing git‘s `description’ file suggests one style, but no man page or other reference to why it should be the way it is.

  • How to configure multiple TFS 2015 projects to point to the same Git repository?
  • using git pull/push via sftp-only connection
  • Git pre-commit hook not adding file on Windows
  • How to manage further development on a Github collaboration after a pull request but before upstream merge
  • git push fails with git-credential-winstore
  • Cannot pull or clone from Bonobo Git Server
  • 3 Solutions collect form web for “what should be in the git description file?”

    description file is only used by the GitWeb program ( to display the description of the repo on the GitWeb page)

    https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain

    Otherwise, how you use it is left to you and I don’t see a point in a “style” for it.

    The description file can also be read by hook scripts or other scripts pertaining to the repository. For example, one popular hook script, post-receive-email, sends an email to all members when a commit is made to the repository, and uses the contents of the description file as the name of the repository in the email subject.

    description is just a text file that is shown as project description in web frontend.

    Just write there something that explains what the repository is about.

    Git Baby is a git and github fan, let's start git clone.