· ES · 4 min read
10 tips que apliqué en mis commits y me han ayudado muchísimo (con ejemplos).
Desde que sigo estas pautas he hecho que mis contribuciones y código sean mucho más comprensibles, para mí y para los demás.
![]()
Table of Contents
- Unidad lógica:
- Commits Atómicos:
- Coherencia temática:
- Mensajes Claros:
- Prefijo de Mensajes:
- Mensaje en Presente:
- Referencia a Problemas:
- Evita commits innecesarios:
- Amend Commits:
- Referencia los commits siempre que sea posible
Unidad lógica:
Cada commit debe representar una unidad lógica de trabajo completa. Esto significa que el commit debe contener todos los cambios necesarios para implementar una nueva característica, resolver un problema o realizar una tarea concreta.
//no recomendable
git commit -m "feat: env added and fetch implemented"
//recomendable
git commit -m "feat: env variables added, dependencies updated and service for fetching main data implemented"
Commits Atómicos:
Realiza commits pequeños y atómicos, enfocados en una única tarea o cambio y con un estado funcional y coherente. Esto facilita la revisión y comprensión de los cambios en el historial. Evita realizar commits que dejen el código en un estado inestable o incompilable.
#no recomendable, acción muy genérica que seguramente haya implicado muchos cambios en el código
git commit -m "feat: product catalog"
#recomendable: fracciona las acciones y ve haciendo commits conforme estén finalizadas
git commit -m "feat: add product catalog table header added"
git commit -m "feat: add product catalog table body added"
git commit -m "feat: add orderby in product catalog table implemented"
Te recomiendo que le eches un vistazo a este artículo sobre Atomic Commits
Coherencia temática:
Agrupa cambios relacionados en un mismo commit. Por ejemplo, si estás trabajando en una función y realizas cambios en múltiples archivos para implementarla, estos cambios deben agruparse en un solo commit.
#archivos modificados:
#product.js
#useFecthProducts.js
#CartProvider.js
git commit -m "feat: add POST in order to get product by id"Mensajes Claros:
Proporciona un mensaje de commit significativo que describa de manera clara y concisa el propósito del commit. Esto ayuda a otros miembros del equipo a comprender rápidamente el cambio introducido.
#no recomendable
git commit -m "syles: create variables"
#recomendable:
git commit -m "feat: create sass variables with global styles"
Prefijo de Mensajes:
Puedes usar prefijos en tus mensajes de commit para indicar el tipo de cambio que realizaste. Por ejemplo:
feat: Nueva característicafix: Corrección de errordocs: Cambios en la documentaciónstyle: Cambios de estilo (formato, espacios en blanco, etc.)refactor: Cambios de refactorización de códigotest: Cambios en pruebaschore: Tareas de mantenimiento, mejoras, etc.
git commit -m "feat: tags functionality added in tasks"
git commit -m "fix: rxjs's finalize() fixed in table after load data"
git commit -m "refactor: unnecesary modules purged in app.module"
git commit -m "style: main styles in secondary and primary buttons changed"
git commit -m "docs: README.md with intructions about app commands added"
git commit -m "test: unit testing for user fetching service implemented"
git commit -m "chore: change from SQlite to MySQL as main databaseMensaje en Presente:
Escribe los mensajes de commit en tiempo presente imperativo. Por ejemplo, "Agregada función de búsqueda" en lugar de "Agregó función de búsqueda".
Referencia a Problemas:
Si tu proyecto utiliza algún sistema de seguimiento de problemas (como GitHub Issues), puedes referenciarlos en los mensajes de commit. Por ejemplo: "Corrige error de validación (#123)".
Evita commits innecesarios:
No realices commits por cada pequeño cambio incremental mientras trabajas en una tarea. En su lugar, espera a tener un conjunto coherente de cambios antes de hacer un commit.
Amend Commits:
Si cometes un error en un commit reciente y aún no lo has enviado, puedes usar git commit --amend para corregirlo.
Aquí tienes un enlace con más información acerca de cómo puedes usarlo en tu día a día.
Referencia los commits siempre que sea posible
Si el trabajo sobre el cual estás escribiendo un commit resuelve, modifica o guarda relación con un commit previamente escrito, referéncialo. Esto te permitirá en un futuro analizar el historial de acciones sobre un determinado bug o implementación en tu código.
#correcto pero mejorable
git commit -m "fix: mongodb database connection fixed"
#correcto: haciendo click sobre la referencia podrás ver el contenido relacionado con el bug a resolver.
git commit -m "fix: mongodb database connection fixed (#1234)"
Recuerda que unos buenos hábitos de commit no solo facilitan la colaboración con otros, sino que también te ayudan a mantenerte organizado y a entender mejor el historial de tu proyecto.