Show Menu
Cheatography
  1. Home >
  2. Programming >

Commits Convencionales Cheat Sheet (DRAFT) by

para devops y uso interno

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Para que sirve?

Normativa simple de commits
Facilita la navegacion del historial
<tipo>(c­ontexto opcional):
<descri­pcion>

[cuerpo opcional]
[nota(s) al pie opcional(es)]

Reglas

1. Los commits DEBEN incluir un prefijo con los tipos definidos, seguido de dos puntos y espacio. Ej: 
build:
2. El contexto, el body y el pie son opcionales
3. El contexto se define en parent­esis. Ej: 
feat(s­ona­rqube):
Este provee mas inform­acion sobre el bloque de codigo que se esta trabaj­ando. En caso de ser varios archivos se ignora
4. Una descri­pcion DEBE seguir al tipo. Se puede definir en imperativo o conjugado solamente
5. Los BREAKING CHANGE DEBEN contener un body y/o notas al pie indicando que ha cambiado en detalle
 

Tipo

fix
solucion a un problema de usuario, desde el codigo
feat
introduce una nueva funcion en el codigo
BREAKING CHANGE o !
Se refiere a un cambio de version mayor
docs
cambios a documentos del proyecto
build
cambios relaci­onados al build stage o depend­encias
limpieza (chore)
organi­zacion de codigo sin agregar nada nuevo
refactor
no resuelve nada pero ayuda a identi­ficar cambios semanticos
ci
cambios en archivos del pipeline y/o scripts de CI, CD

Ejemplos

Ejemplo de BREAKING CHANGE:

fix!(d­epe­nde­ncias): update de restCharp

Este cambio se realizo porque la version 107.2.1 quedo obsoleta en fecha AB/08/1990
------­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­------
fix(BR­­EAKING CHANGE): Cambio de string de conexion

Este cambio se realizo para utilizar la nueva base de datos en azure
------­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­---­------
Ejemplo de contexto:

fix(SE­­RI­N­C­PP­­RD01): Actualizar apache y OpenSSL
ci(des­­pl­i­e­gu­­ete­­mp­rano): Cambio de rama origen para prueba
feat(2­66558): Agregando endpoint para validar si el token es valido