¿Cuál es la convención para el contenido de una confirmación inicial/primera de git?

4 minutos de lectura

avatar de usuario
andydavies

Sé que las confirmaciones de Git deben realizarse para cada cambio lógico, pero ¿cuál es la convención (si existe alguna) para la primera confirmación?

[note: I’m not inviting opinion/discussion on this – if there isn’t a common convention then fine].

Por ejemplo, comencé un sitio web desde cero con index.html: mi primer compromiso de ‘cambio lógico’ podría ser cualquier cosa, desde agregar el <head> elementos, agregando la estructura HTML, o agregando el contenido básico y CSS. ¿O debería la primera confirmación ser la primera versión ‘funcional’?

Editar: no me refiero al mensaje de confirmación; Me refiero al contenido de los archivos.

  • mi convención es git commit --allow-emptypor lo que tengo un punto de partida vacío, lo que me permite crear ramas completamente nuevas sin relación con nada en el repositorio, lo que puede resultar útil.

    -Kenney

    30 de enero de 2016 a las 15:31

  • El hecho de que no esté invitando a la discusión/opinión no significa que no vaya a obtenerla 🙂 Me gusta ir con “Abandonad toda esperanza, los que entráis aquí” (la inscripción en la entrada al Infierno en el infierno de Dante ). Si eso es demasiado literario, “¡primer mensaje!” funciona también En serio, sin embargo, ¿qué importa? ¿Hay alguna consecuencia si se utiliza un mensaje no convencional? Bueno, aparte de un mensaje como “Confirmación inicial y, por cierto, la contraseña de root para el servidor de producción es asdf123”. No tenga miedo al compromiso… escriba un mensaje y vuelva a su código.

    – Pablo

    30 de enero de 2016 a las 16:21

  • No me refiero al mensaje de confirmación, me refiero a cuál debería ser el contenido de los archivos confirmados (he editado la pregunta para aclarar)

    – andy davies

    30/01/2016 a las 16:30


  • @Kenney Yo también. Una confirmación inicial vacía también brinda la ventaja de poder reorganizar o filtrar la ramificación de todo el repositorio sin la necesidad de interruptores adicionales (y feos) como --root.

    – Pato Perl

    31 de enero de 2016 a las 15:05

Por lo general, la primera confirmación se denomina “Confirmación inicial”.

Como mejor práctica es incluir un README archivo que describe el proyecto.
los README es por lo general es un archivo md.

Solo por diversión lee esto: Divertidos mensajes iniciales de confirmación de git:

  • También puede poner cualquier código que desee. pero dado que esta es la primera confirmación, es posible que aún no tenga suficiente contenido, por lo que README es un contenido decente para la primera confirmación.

    – Asistente de código

    30 de enero de 2016 a las 15:56

Parece que no hay una convención establecida entonces (para el contenido, no para el mensaje).

Encontré útil este artículo sobre las mejores prácticas: https://sethrobertson.github.io/GitBestPractices/

  • No se menciona en el artículo sobre “raíz” o “compromiso inicial”. Me ocupé de esto antes [1], pero para resumir la convención una vez más después de años: – Etiquete las confirmaciones que le interesen, por ejemplo, ‘root’, ‘root-commit’, numérelas. Lo que sea. – Usar git describe para ver dónde estás, no hay etiquetas significa que describe da un error. [1] stackoverflow.com/a/12503512/325566

    – mpe

    20 de noviembre de 2018 a las 14:12


Como han informado otros, no he encontrado una convención estándar, así que a continuación compartiré lo que suelo hacer.

Después de crear el repositorio, creo una confirmación vacía cuyo mensaje es Confirmación vacía inicial. Tienes que pasar la opción --allow-empty. De lo contrario, recibirá un mensaje que dice nada que cometer.

$ git init # creates repository
$ git commit --allow-empty -m'Initial empty commit' # creates empty commit

Me gusta hacerlo de esta manera porque me hace pensar en este compromiso como la raíz vacía de mi repositorio. Además, puedo empujar inmediatamente este repositorio sin ningún contenido. Después de este compromiso, generalmente agrego el archivo README.md.

No estoy seguro de si existe alguna convención particular para una primera confirmación. Siempre trato de tener al menos alguna semejanza con el esqueleto de un proyecto, y probablemente un README archivo que describe los propósitos previstos.

¿Ha sido útil esta solución?