1

Formato de comentarios en los commits

Marco
MarcoET
40140

Este tutorial lo elaboré con el propósito de mostrarles un formato para los comentarios de nuestros commits, que nos ayude en la navegación y nos de un idea de primer vistazo de los cambios realizados dentro del los mismo.

Este formato lo pueden aplicar también en sus proyectos personales que tienen actualmente, de esta manera podremos tener proyectos muy profesionales.

La estructura del mensaje es la siguiente:

<type>(<scope>): <subject>

Ejemplo

feat(assets): se integran los assets para redes sociales.
fix(Signin): se corrige inicio de sesión con facebook

Type

En el tipo de commit tenemos las siguientes opciones para elegir.

feat: Una nueva funcionalidad.
fix: Cuando se va a subir alguna corrección.
docs: Solo para los cambios en los documentos.
style: Estos es cuando el cambio no afecta el código o la funcionalidad (Espacios en blanco, formato, punto y coma, etc), solo la estructura.
refactor: Es cuando el cambió en el código no corrige un error o agrega una nueva funcionalidad. Mejora en el código.
Scope
Es el ámbito donde se realizó en cambio, config, web-server, index, modulo, etc.

Subject
Contiene la descripción de cambio, se debe de utilizar en tiempo presente, máximo 100 caracteres.

Espero que este pequeño tutorial le sea de mucha ayuda, coloquen sus comentarios y si gustan pueden compartir como manejan los comentarios en donde trabajan o en sus proyectos personales.

Escribe tu comentario
+ 2