E02_Commits
Versión
1.0
Objetivo
Definir una estructura a seguir al momento de realizar commits con la finalidad de mejorar la documentación de los cambios al repositorio, cuando cada integrante del equipo ejecute uno. Dar mejor entendimiento al resto del equipo de lo que se hizo en el código.
Estándar
- Usar el verbo imperativo.
- No usar punto final o suspensivos en los mensajes.
- Usar un máximo de 50 caracteres por commit
- Si tu commit abarca muchos cambios, es mejor dividirlo en varios commits.
- En caso de necesitar una descripción más específica usa el comando git commit, lo que te permitirá agregar un cuerpo a la descripción del commit.
- Usar un prefijo que resuma qué tipo de commit se realizó.
Ejemplos
- feat: Agregar opción de obtener documento
- fix: problema con las descargas
- remove: notificación aleatoria
- git commit -m “fix: Cambiar tamaño del logotipo” (No más de 50 caracteres)
- git commit -m “feat: “Agregar opción de obtener documento” (No usar punto final o suspensivos)
Prefijos
- fix: arreglar un bug que afecta al usuario
- feat: una nueva característica para el usuario
- ci: cambios en la integración continua
- remove: quitar una característica o cambio