Hacer un buen commit es una parte importante del flujo de trabajo como desarrollador, sin importar si trabajas en back-end, front-end o mobile. Lo que realmente importa es hacerlo bien.
Un amigo solía decirme: “Lo importante es hacerlo bien, no importa el método ni el tiempo que tome, porque al final lo que cuenta es hacerlo correctamente”.
En muchas ocasiones, nos encontramos con commits que a veces no entendemos, y no es necesariamente porque estén mal hechos, sino porque no son claros. Comentar nuestro código es una parte constante de nuestra rutina diaria, y por eso debemos esforzarnos un poco en hacerlo bien.
Aquí tienes algunos consejos para hacer un buen commit:
Divide tus cambios: Es mejor hacer commits pequeños y enfocados en cambios específicos, en lugar de hacer un solo commit con muchos cambios diferentes. Esto facilita entender los cambios y deshacerlos si es necesario.
Escribe mensajes descriptivos: El mensaje del commit debe ser claro y descriptivo. Debe explicar qué cambios se realizaron y por qué. Un buen formato para el mensaje del commit es una línea de resumen breve (máximo 50-72 caracteres), seguida de una descripción más detallada si es necesario.
Ejemplo de descripción más detallada:
“Se corrigió un error que causaba que el formulario de registro no validara correctamente las direcciones de correo electrónico ingresadas por los usuarios. La validación ahora funciona correctamente, garantizando que solo se acepten direcciones de correo electrónico válidas según el estándar RFC 5322. Este cambio soluciona un problema importante que afectaba la funcionalidad de registro de nuevos usuarios en la plataforma.”
Usa un lenguaje imperativo: Escribe el mensaje en tiempo presente y en imperativo. Por ejemplo, “Agrega funcionalidad de inicio de sesión” en lugar de “Agregué funcionalidad de inicio de sesión”.
Mantén la consistencia: Sigue un estilo de escritura consistente en tus mensajes de commit para facilitar su lectura y comprensión por parte de otros colaboradores.
Revisa tus cambios antes de hacer el commit: Asegúrate de revisar tus cambios antes de confirmarlos. Esto incluye verificar que todos los archivos relevantes estén incluidos en el commit y que no haya errores, incluyendo errores de escritura y de sintaxis.
No incluyas cambios irrelevantes: Evita incluir cambios irrelevantes o archivos temporales en tus commits. Esto hace que sea más fácil revisar los cambios y entender su propósito.
Faça certo desde o começo: A chave para um bom commit
Um bom commit não é apenas sobre código, mas sobre clareza e precisão, Dividir suas mudanças, ser descritivo e manter a consistência são alguns dos passos para alcançar um commit claro e eficiente
Fazer um bom commit é uma parte importante do fluxo de trabalho como desenvolvedor, não importa se você trabalha com back-end, front-end ou mobile. O que realmente importa é fazer bem. Um amigo costumava me dizer: “O importante é fazer bem, não importa o método ou o tempo que leve, porque, no final, o que conta é fazer corretamente”.
Muitas vezes, nos deparamos com commits que às vezes não entendemos, e não é necessariamente porque foram feitos de forma errada, mas porque não são claros. Comentar o nosso código é uma parte constante da nossa rotina diária, e é por isso que devemos nos esforçar para fazê-lo bem.
Aqui estão algumas dicas para fazer um bom commit:
Divida suas alterações: É melhor fazer commits pequenos e focados em alterações específicas, em vez de fazer um único commit com muitas alterações diferentes. Isso facilita a compreensão das mudanças e a reversão, se necessário.
Escreva mensagens descritivas: A mensagem do commit deve ser clara e descritiva. Ela deve explicar quais alterações foram feitas e por que. Um bom formato para a mensagem do commit é uma linha de resumo breve (máximo de 50-72 caracteres), seguida de uma descrição mais detalhada, se necessário.
Exemplo de descrição mais detalhada:
“Foi corrigido um erro que fazia com que o formulário de registro não validasse corretamente os endereços de e-mail inseridos pelos usuários. A validação agora funciona corretamente, garantindo que apenas endereços de e-mail válidos, conforme o padrão RFC 5322, sejam aceitos. Essa mudança corrige um problema importante que afetava a funcionalidade de registro de novos usuários na plataforma.”
Use linguagem imperativa: Escreva a mensagem no tempo presente e no imperativo. Por exemplo, “Adiciona funcionalidade de login” em vez de “Adicionei funcionalidade de login”.
Mantenha a consistência: Siga um estilo de escrita consistente nas suas mensagens de commit para facilitar a leitura e a compreensão por parte de outros colaboradores.
Revise suas alterações antes de fazer o commit: Certifique-se de revisar suas alterações antes de confirmá-las. Isso inclui verificar se todos os arquivos relevantes estão incluídos no commit e se não há erros, incluindo erros de escrita e sintaxe.
Não inclua alterações irrelevantes: Evite incluir alterações irrelevantes ou arquivos temporários nos seus commits. Isso facilita a revisão das alterações e a compreensão do seu propósito.