Estándar para realizar commits - doapps/software GitHub Wiki
1. Consideraciones generales
- Se realizará en español.
- El primer commit será nombrado:
Iniciar proyecto
. - El nombre del commit siempre debe inciar con un verbo infinitivo con la primera letra en mayúscula, por ejemplo
Validar sesión de usuario
. - El nombre del commit debe ser una oración coherente que explique de manera concisa lo que se desarrolló.
- El nombre del commit no debe ser muy extenso, en caso sea necesario más detalle se puede agregar una descripción al commit.
2. Requisitos para hacer un commit
- Los cambios realizados deben estar asociadas a alguna tarea o funcionalidad definida por el desarrollador.
- Si los cambios generados son muy pequeños tratar de agruparlos con otros cambios asociados.
- La tarea debe estar concluida para poder realizar el commit.
3. Casos excepcionales que ameritan hacer un commit
- Un cambio urgente requerido por el cliente o product manager por más pequeño que sea.
- Resolución de conflictos.
4. No amerita realizar un commit
- Borrar logs o comentarios que fueron útiles en la etapa de desarrollo, estos deberán borrarse o eliminarse a medida que se desarrolla.
- Tareas inconclusas.
5. Ejemplos Nombre de los commits
- Diseñar Login
- Filtrar cursos por categoría
- Validar credenciales de acceso login
- Diseñar registro de usuario
- Diseñar animación de registro de usuario
- Integrar servicio de registro de usuario
- Ordenar cursos por fecha
- Ordenar empresas alfabeticamente por nombre y rubro
6. Como nombrar un commit de refactorización, fix o cambios urgentes
Refactorizar validación de login
Arreglar lectura de json de servicio de listado empresas
Actualizar tamaño del botón