什么应该在git描述文件中？

Question

在初始化新的本地存储库后,存在一个description文件.

它用于什么以及如何格式化？或者它只是一个本地帮助文件.

这个线程访问git的`description'文件建议一种风格,但没有手册页或其他参考,为什么它应该是它的方式.

Answer 1

description 文件仅由GitWeb程序使用(在GitWeb页面上显示repo的描述)

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

否则,你如何使用它留给你,我没有看到它的"风格"点.

Answer 2

该description文件也可以通过钩子脚本或与存储库有关的其他脚本来读取.例如,一个流行的钩子脚本(post-receive-email)在向存储库提交时向所有成员发送电子邮件,并使用该description文件的内容作为电子邮件主题中的存储库的名称.

Answer 3

description只是一个文本文件,在Web前端中显示为项目描述.

只需写一些解释存储库内容的东西.