Conventional commits, a good practice
Definition
Conventional Commits is a specification for writing commit messages in a way that is easy for
humans and machines to understand.
It defines a standard format for commit messages, which consists of the following parts:
Parts
- Type:
The type of commit, such as feat, fix, docs, or chore.
- Scope:
The scope of the change, such as a-file, a-module, or the-project.
- Description:
A brief description of the change.
- Breaking change:
An optional section to indicate if the commit introduces a breaking change.
Usage example
- feat:
Nueva funcionalidad
- Ejemplo:
"feat(user):
Agregar sistema de login"
- fix:
Corrección de errores
- Ejemplo:
"fix(database):
Solucionar bug de consultas lentas"
- style:
Cambios estilísticos (sin impacto funcional)
- Ejemplo:
"style(code):
Formatear código de JavaScript"
- refactor:
Refactorings internos
- Ejemplo:
"refactor(auth):
Simplificar lógica de autenticación"
- chore:
Tareas administrativas
- Ejemplo:
"chore(deploy):
Configurar CI/CD pipeline"
- ci:
Cambios en procesos de integración continua
- Ejemplo:
"ci(cron):
Agregar tarea cron diaria para limpieza de cache"
- perf:
Optimización de rendimiento
- Ejemplo:
"perf(db):
Indexar columna de productos para mejorar consultas"
- build:
Cambios en scripts de construcción
- Ejemplo:
"build(webpack):
Actualizar configuración de webpack"
- revert:
Revertir cambios anteriores
- Ejemplo:
"revert(1234):
Deshacer cambio de versión anterior"
- test:
Actualización de tests existentes
- Ejemplo:
"test(unit):
Actualizar tests unitarios para nueva API"
- docs:
Actualización de documentación
- Ejemplo:
"docs(contributing):
Añadir guía de contribución"
Estos tipos de títulos ayudan a categorizar claramente los cambios en el proyecto, facilitando
la revisión y comprensión del historial de desarrollo.
To use conventional commits, you can use a git hook or a tool like commitizen:
https://commitizen.github.io/cz-cli/ to help you write the commit messages in the correct
format.
Benefits
Here are some of the benefits of using conventional commits:
It makes it easier for humans to understand the changes that have been made to a project.
It makes it easier for machines to parse commit messages and generate change logs, changelogs,
and other documentation.
It helps to ensure that commit messages are consistent and easy to find.
If you are working on a project that uses conventional commits, I encourage you to follow the
specification and write clear and concise commit messages.
It will make your project easier to maintain and understand for everyone involved.
Aditional resources
Here are some additional resources that you may find helpful: