Existen diferentes formas de escribir commit extendidos, unas más usadas que otras. Vamos a examinar con detalle las diferentes posibilidades de que disponemos.
Ejecutando git commit
Tan sólo necesitamos realizar el commit directamente sin parámetros. Se nos abrirá el editor que tengamos configurado y a continuación incluimos la descripción principal seguida de un salto de párrafo con nuestros comentarios extras.
git commit es equivalente a realizar un git commit –amend
1 |
$ git commit |
Sin necesidad de ir al editor
Una de las opciones más utilizadas es usar el parámetro -m. Desde el mismo shell y sin necesidad de abrir el editor vamos a ir incluyendo la descripción ampliada del commit.
1 2 3 4 |
$ git commit -m 'titulo del commit > > linea 1 > linea 2' |
Usando la sintaxís de comandos de shell
Esta opción es menos común ya que nos obliga a usar caracteres especiales.
1 |
$ git commit -m $'titulo\n\ndescripcion1\ndescripcion2' |
incluyendo nuevas líneas al commit
Esta forma nos obliga a incluir parámertros -m con cada nueva línea que vayamos incluyendo.
1 |
$ git commit -m "titulo" -m "descripción commit linea 1" -m "descripción commit linea 2" |
El problema de este método es que se van creando saltos de párrafo con cada nueva línea
Cambiando el editor
Otra opción es cambiar el editor por defecto que tengamos asignado (vi), por nuestro propio editor (por ejemplo VSCode)
Para ello tendremos que cambiar en nuestra configuración la opción core.editor
1 2 |
git config --global core.editor "code --wait" git commit |
De esta forma cuando realizamos nuevos commits se nos abrirá una nueva instancia del editor donde incluiremos los comentarios realizados.