¡Escribe mejores commits!
Por lo general, un buen programador debe poseer buenas habilidades para programar, tanto para registrar como documentar su trabajo. Los que solemos realizar código sin planear solemos cometer el error de no llevar un registro ordenado de neustro progreso en el trabajo ni de especificar cadaa fraagmento imporante del código. Esta es una habilidad que proviene de ser ordenado, y usualmente nos hemos acostumbrado a vivir en el desorden. Sin embargo, he reunido aspectos importanates para tener mejores commits, un aspecto que debemos cuidar como desarrolladores para mejorar nuestro manejo de Github.
¿Para qué necesitamos buenos commits?
Me gusta pensar que el apartado de commits de un proyecto funciona como un diario, pero quitándole las cosas sentimentales. El texto que elegimos que será parte de nuestro commit ayudará a cualquier persona, incluidos nosotros, a entender mejor el código, y tener un buen vistazo rápido de cada avance realizado en el mismo. Si realizamos buenos commits, podremos volver atrás, ver nuestro progreso y entender porqué se tomaraon ciertas decisiones en el proyecto.
Conventional commits
Esta página nos presenta comprensiblemente el reglamento que debemos seguir para escribir commits claros y concisos. Acá en el blog haré un breve resumen de lo presentado en la página.
Estrúctura de un commit:
La parte más importante ocurre en la primera línea. Encontramos 3 parámetros. Type corresponde al tipo de cambio que realizamos en el código, hablaremos de eso más adelante. El scope es información entre paréntesis que sirve para dar más contexto del feature o cambio que estamos hablando. Por último, la descripción hace referencia a explicar el cambio que hemos realizaado.
Tipos de commit
Debemos especificar el tipo de cambio en al sección type de nuestro commit. Para ello tenemos principalamente estas categorias:
Fix: Se trata de un cambio realizado para arreglar un problema en el código.
Feat: se trata de un cambio en el que añadimos una nueva característica al proyecto, puedes interpretarlo como nuevas funciones en el código.
Podemos aañadir más verbos y dependerá de la forma en la que querramos escribir nuestros commits, aunque estos son los que mejor se adaptan a al estructura.
Cuerpo del commit
El cuerpo es opcional, pero laa página nos dice que podemos añadir una sección llamada BREAKING CHANGE para avisar de un cambio importante en el código acompañado de neustro cambio principal:
Poco a poco neustros commits irán mejorando y tendremos una mejor habilidad para especificar secciones de nuestro código. Trabajar con buenos commits puede automatizar otras partes del proyecto. Para tener una mejor idea recomiendo leer la página.
No hay comentarios: