Que devrait-il y avoir dans le fichier de description de git?

Après avoir initialisé un nouveau référentiel local, un fichier de description présent.

À quoi sert-il et comment dois-je le formater? Ou est-ce simplement un fichier d’aide local.

Cette discussion L’ access au fichier `description ‘de git suggère un style, mais aucune page de manuel ni aucune autre référence à la raison pour laquelle cela devrait être.

fichier de description est uniquement utilisé par le programme GitWeb (pour afficher la description du repository sur la page GitWeb)

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

Sinon, la façon dont vous l’utilisez est laissée à vous et je ne vois pas de point dans un “style” pour cela.

Le fichier de description peut également être lu par des scripts hook ou d’autres scripts appartenant au référentiel. Par exemple, un script de hook populaire, post-receive-email , envoie un e-mail à tous les membres quand une validation est effectuée dans le référentiel et utilise le contenu du fichier de description comme nom du référentiel dans l’object du courrier électronique.

La description est juste un fichier texte qui est affiché en tant que description de projet dans Web Frontend.

Écrivez simplement quelque chose qui explique la nature du repository.

Le contenu de ce fichier est également utilisé par gitolite avec la commande “desc -ld”.

vous pouvez modifier ce fichier, mais il ne me semble pas que cela soit pris en compte pour être engagé.