DEV Community

Cover image for Cómo escribir excelentes commits
Marco Elizalde
Marco Elizalde

Posted on

Cómo escribir excelentes commits

Te ha pasado que cuando entras a un repositorio y buscas la lista de commits los comentarios son poco entendibles, no tienen una estructura definida o colocan mensajes como «se arregló error», pero estos comentarios no te aportan nada para entender el porqué del commit.

Elaboré este pequeño tutorial para mostrarte un formato que puedes aplicar en los comentarios de tus commits, que te ayuden en la navegación y da una idea de primer vistazo de los cambios realizados dentro de los mismos.

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: Cuando el cambio no afecta el código o la funcionalidad (Espacios en blanco, formato, punto y coma, etc), solo la estructura.
  • refactor: Cuando el cambio 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ó el cambio, config, web-server, index, modulo, etc. Si estas trabajando en Gitlab con incidencias, puedes asociar fácilmente el comentario con la incidencia agregando # y el número de esta, te dejo un repo como referencia https://gitlab.com/kairos6/api-kairos.

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

Ultimos consejos:

  • Escribe los comentarios en inglés, esto le dará un plus a tu -repositorio.
  • Si trabajas con más personas, agrega esta información en el archivo de contribución para que tu equipo conozca como se tiene que crear los mensajes de los commits.
  • Tus commits deben de ser pequeños, es decir que contengan la menor cantidad de cambios, esto te ayudará a tener un mayor seguimiento de tus cambios.

Ya tienes todo para que tus proyectos sean muy profesionales, empieza ya a aplicar este formato a todos tus proyectos. Compárteme en mis redes sociales como lo aplicaste en tus commits o si tienes alguna otra forma de hacerlo.

Discussion (0)