¿Hay alguna manera de agregar una descripción a un file al presionarlo por primera vez en git?

Cuando presiono un file por primera vez en el repository de GIT, ¿puedo agregar una breve descripción sobre ese file? (por ejemplo, qué contiene el file, cuándo modificar el file, etc.)

Sé que podemos agregar un file de descripción para el repository, pero quería agregar una descripción a los files individuales.

git no mantiene ningún tipo de "descripción" de un file, ni mantiene información similar sobre un repository como un todo. Algunos services (como GitHub o Bitbucket) pueden tratar un file de forma especial (por ejemplo, GitHub tratará varias variantes de README y lo mostrará de forma pnetworkingeterminada cuando navegue por el repository).

La mejor manera de documentar el file es proporcionar un post de confirmación apropiado cuando primero agrega el file al repository. Este post de compromiso es fácil de recuperar usando algo como:

 git log --diff-filter=A myfile 

Esto le pide a git que solo muestre commits donde el file myfile fue agregado --diff-filter=A

Puede cambiarlo después de que exista el repository remoto (simple).

Escriba directamente en el file de esta manera:

 ssh gitserver 'echo "My new description" > /path/to/description' 

Esto supone que:

  • El server ejecuta Linux.
  • Usted sabe que la ruta al repository git en el server (probablemente) vea su ruta remota (git remote -v).
  • El acceso de Git al server se configura mediante ssh.
  • El repository ya ha sido empujado.