Estndar para el manejo de commits

Propsito
El uso de esta gua tiene tres propsitos importantes:
Para ayudarnos a escribir un buen mensaje en el commit del cambio realizado.
Para acelerar el proceso de revisin.
Para ayudar a la futura mantenibilidad del cdigo.
Permitir la navegacin sencilla a travs de la historia del proyecto.
Generacin automtica de la lista de cambios.

Formato del mensaje del commit

El mensaje del commit de un cambio en la historia de vida del proyecto, se compone de las
siguientes tres partes:
(asunto)
(cuerpo)
(pie)

A continuacin se describen cada una de las partes.

Asunto del mensaje

La primer parte es el asunto del mensaje, es decir, la primera lnea, debe ser una breve
descripcin del cambio, no podr tener ms de 50 caracteres, la segunda lnea ser siempre
en blanco, y las otras lneas estarn dentro del rango de 72 caracteres.
Se sugiere que el asunto incluya el tipo y alcance:
(tipo) (alcance): <asunto>
El tipo y el alcance, podran tener los siguientes valores:
Tipo
Feature (nueva funcin para el usuario)
Correccin (correccin de errores para el usuario)
Docs (cambios en la documentacin)
Estilo (formato, falta de puntos y comas, etc, ningn cambio de cdigo en produccin)
Refactor (refactorizacin del cdigo en produccin, por ejemplo, cambiar el nombre de una
variable)
Prueba (la adicin de pruebas)
Tarea (tareas de actualizacin, sin cambiar el cdigo en produccin)

Alcance
Inicial
Configuracin
Web-server
Proxy

Cuerpo del mensaje

En el cuerpo del mensaje se usar el tiempo presente imperativo, como Cambia, en lugar
de Cambiado o Cambios.
Se debe incluir la descripcin del cambio funcional, el porque del cambio y la diferencia con
el comportamiento anterior, se sugiere describir el problema original, el resultado del cambio
y posibles mejoras, as como limitaciones de la solucin.
Recuerda utiliza el cuerpo para explicar qu y por qu vs cmo.

Pie del mensaje

En el pie del mensaje se incluirn referencias externas.
Los temas cerrados deben ser listados en una lnea, se antepone la palabra Cierra-error.
La referencia a implementaciones se har con la palabra Implementa y para el id del cambio
se antepone la palabra Cambio-id.
Ejemplo
Cierra-error : #234
Implementa: Blueprint libvirt-xml-cpu-model
Cambio-id : 8f2598a

Ejemplo
Cambia el mtodo get_cpu_info libvirt para utilizar la API de configuracin
El mtodo get_cpu_info en el controlador libvirt utiliza actualmente
consultas XPath para extraer informacin de las capacidades de
un documento XML. Cambiar esto para utilizar la nueva clase config
libvritConfigCaps. Tambin proporciona un caso de prueba para validad
los datos que devuelve.
Cierra-error : #234
Implementa: Blueprint libvirt-xml-cpu-model
Cambio-id : 8f2598a

Resumen de la estructura del commit

Proporcionar una breve descripcin del cambio en la primera lnea.

Escribe la primera lnea en modo imperativo como si lo estuvieras ordenando a
alguien. Como por ejemplo Arreglar, Aadir, Cambio en lugar de Agregado, Ha
cambiado.
La primera lnea debe limitarse a 50 caracteres y no debe terminar con un punto.
Inserte una lnea en blanco despus de la primera lnea.
Proporcionar una descripcin detallada del cambio en las siguientes lneas.
Las lneas siguientes se sugieren de 72 caracteres.
Describir en el cuerpo del mensaje el problema original.
Describir el cambio funcional que se realiza, es decir, la solucin.
Describir el resultado del cambio e incluir la descripcin de posibilidades de mejoras.
Las vietas a utilizar sern *
Si parece difcil resumir lo que su commit hace, puede ser debido a que incluye varios
cambios lgicos o correcciones de errores, y es mejor que se divida en pequeos
commits utilizando git add -p .
Entre cada prrafo habr una lnea blanca.
Uso de maysculas al iniciar la oracin.
Ponga una referencia al 'Cambio-id: #NNNNN' ', 'Cierra-Error: #NNNNN' cuando sea
necesario.

Algunos otros puntos a tomar en cuenta

Describir el escenario del problema.

Describir la arquitectura aproximada de la solucin.
Notas de las limitaciones de la solucin.

Ejemplo