Git: agregar un mensaje dedicado

    Como muchos programadores han descubierto por las malas, es extremadamente importante agregar documentaci贸n para que pueda realizar f谩cilmente modificaciones en su c贸digo, solucionar problemas, pasar a otros, etc. Eso no tiene sentido ahora porque su c贸digo ahora tiene sentido para darle significado en 6 meses (o incluso semanas, en realidad). Probablemente est茅 acostumbrado a documentar su c贸digo real, pero esta misma pr谩ctica tambi茅n debe seguirse con sus promesas de control de versiones.

    En Git, hay algunas formas de documentar sus cambios, pero nos centraremos principalmente en c贸mo hacerlo para compromisos individuales en este breve art铆culo.

    Mientras ve un repositorio en GitHub, es posible que haya notado los mensajes junto a un archivo o carpeta:

    Estos mensajes generalmente se agregan al repositorio en el momento en que realiza el compromiso, aunque tambi茅n puede recuperar los mensajes de compromiso de forma retroactiva.

    En GitHub, el mensaje est谩 al lado del archivo o carpeta del 煤ltimo compromiso donde se cambi贸 ese archivo / carpeta. As铆 que no todos son necesariamente de la 煤ltima promesa. De lo contrario, no ser铆a muy 煤til si GitHub mostrara el mismo mensaje de compromiso del 煤ltimo compromiso para cada archivo.

    Para agregar este mensaje, necesita el -m bandera mientras se ejecuta git commit. Su mensaje debe seguir inmediatamente a la bandera y estar entre comillas. Un ejemplo de esto se ve as铆:

    $ git commit index.js -m "Fixed world-ending bug (#281)"
    

    Mensajes en l铆nea

    No siempre se puede describir un cambio complejo con un breve comentario de una l铆nea. Un aspecto interesante de esto -m Un banner es que puede agregar varios elementos a su mensaje utilizando el -m m煤ltiples banderas iguales commit orden:

    $ git commit index.js -m "My Changes" -m "- Fixed a critical bug" -m "- Probably added more bugs"
    

    Estos mensajes m煤ltiples aparecer谩n en la promesa resultante:

    My Changes
    - Fixed a critical bug
    - Probably added more bugs
    

    Otra opci贸n, que depende del shell que est茅 utilizando, es ingresar una comilla simple o una comilla doble y presionar Enter, sin cerrar la cita. Esto funciona bien en Bash, que no ingresa el pedido hasta que cierra la cotizaci贸n:

    $ git commit index.js -m "My Changes
    - Fixed a critical bug
    - Probably added more bugs
    "
    

    Y finalmente, no tienes el -m bandera en absoluto. Si ignora esta bandera, Git abrir谩 autom谩ticamente un editor de texto para ingresarlo en el mensaje de compromiso.

    .

    Etiquetas:

    Deja una respuesta

    Tu direcci贸n de correo electr贸nico no ser谩 publicada. Los campos obligatorios est谩n marcados con *