Empezando
Aprende nuestra convención de commits
Nos gusta tener un historial de proyecto limpio. Nuestra convención de commits está inspirada en Conventional Commits pero personalizada con gitmoji para hacerlo más visual y divertido.
Estructura
El mensaje del commit debe estructurarse de la siguiente manera y en minúsculas:
<gitmoji> <type> <description> [(#<número de issue>)]
[cuerpo opcional]
[footer(s) opcionales]
Ejemplo
📝 actualizar contribuyentes de la documentación
- Agregar a @jerembdn como contribuyente
- Agregar a @younesbessa como contribuyente
Co-authored-by: Younes Bessa <[email protected]>
La mayor parte del tiempo, una línea simple es suficiente:
📝 actualizar contribuyentes de la documentación
Tipos
Usamos los siguientes tipos de commits:
| Tipo | Descripción |
|---|---|
add | Agregar una nueva función |
fix | Corregir un error |
improve | Mejorar algo |
update | Actualizar algo |
remove | Eliminar algo |
refactor | Refactorizar algo |
rename | Renombrar algo |
move | Mover un archivo o carpeta |
upgrade | Actualizar dependencias |
downgrade | Degradar dependencias |
initial | Commit inicial de un repositorio |
release | Lanzar / etiqueta de versión |
El primer commit de un repositorio usa initial, y una etiqueta de versión usa
release:
🎉 commit inicial
🔖 release @onruntime/translations v0.3.0
Descripción
El <type> es el verbo del sujeto, y la descripción lo completa. Juntos,
forman una oración:
# Bueno
📝 actualizar contribuyentes de la documentación
Así que no abras la descripción con un segundo verbo. El tipo ya es uno, y
el sujeto termina apilando dos oraciones, que es lo que lleva un prefijo fix:. Elimina el verbo y mantén lo que actúa sobre:
# Malo
💄 mejorar reducir la escala de la gema en su tarjeta
🐛 corregir detener el pie de página de envolverse
# Bueno
💄 mejorar el tamaño de la gema en su tarjeta
🐛 corregir el pie de página envolviéndose
Escríbelo en modo imperativo y en minúsculas:
# Malo
📝 actualizados contribuyentes de la documentación
# Malo
📝 Actualizar contribuyentes de la documentación
Un verbo que es un sustantivo
Algunas palabras son ambas, y la que quieres es el sustantivo: ✨ agregar imagen de gráfico abierto está bien. Cuando se lee como un verbo, un artículo lo convierte en una frase nominal nuevamente: ✨ agregar un botón de mostrar más.
Número de Issue
Vincula los commits a los issues añadiendo el número del issue:
📝 actualizar contribuyentes de la documentación (#123)
Cuerpo
Usa el cuerpo para contexto y motivación:
📝 actualizar contribuyentes de la documentación
- Agregar a @jerembdn como contribuyente
- Agregar a @younesbessa como contribuyente
Co-authored-by: Younes Bessa <[email protected]>
Un commit, un propósito
Cada commit debe representar un cambio lógico único. No mezcles cambios no relacionados.