🛠️ Alpura - Estructura de commits
A continuación se explica ¿que es? y cual sería la estructura de los commits que deben ser implementados a la hora de ejeuctar un git commit durante el desarrollo.
🧠 ¿Qué son los Conventional Commits?
Es un estándar de formato para mensajes de commit basado en ciertas reglas. Siguiendo la siguiente sintaxis:
<type>[optional scope]: <description/subject>
⚙️ Type
A continuación se muestra los diferentes types, que podemos usar en nuestra estructura de commit:
| Tipo | Descripción |
|---|---|
build | Cambios que afectan el sistema de compilación o dependencias externas |
ci | Cambios en archivos y scripts de configuración de CI |
docs | Solo cambios en la documentación |
feat | Una nueva característica |
refactor | Cambio que no corrige un error ni añade una característica |
test | Adición de pruebas faltantes o corrección de pruebas existente |
style | Ajustes de formato (puntos y coma, indentación, etc.) que no afectan la lógica y cambios de estilos |
⚙️ Scope
El scope hace refencia al "feature" en donde realizo el cambio.
⚙️ Description/Subject
El asunto contiene una descripción breve del cambio o de los cambios que se realizaron.
tip
- Capitalizar la primer letra, siempre.
- No usar (.) al final de la descripción/asunto
✨ Ejemplos
- feat(users): Add user registration form
- feat(ui-components): Add new date-range-picker component
- docs(changelog): Update release notes for v1.2.0
- docs(readme): Add new installation instructions for Angular 16
- fix(payment-lib): Handle currency conversion edge cases
warning
Toda la estructrura del commit debera estar en ingles.