Guía de mensajes de confirmación

Mensajes de confirmación

Los mensajes de confirmación claros facilitan la revisión de las solicitudes de extracción y la generación de las notas de la versión. El proyecto de Blockly usa commits convencionales para ayudar con esto.

Cada confirmación debe tener el siguiente formato:

<type>: <description>

[optional body]

[optional footer(s)]

Ten en cuenta que el repositorio principal de Blockly tiene un verificador de confirmaciones para ayudar a aplicar esta regla. Si tu solicitud de extracción tiene varias confirmaciones, el verificador de código revisará el título. Si tiene una sola confirmación, se verificará esa confirmación. Lo mejor es que tanto tus confirmaciones individuales como el título de la solicitud de extracción sigan estos lineamientos.

Tipo

El tipo no debe estar vacío y debe estar en minúsculas. A continuación, se incluye una lista de los tipos aceptados.

  • chore: Para las confirmaciones que completan tareas rutinarias o automatizadas, como la actualización de dependencias.

  • deprecate: Para las confirmaciones que dan de baja la funcionalidad.

  • feat: Para las confirmaciones que agregan funciones nuevas a Blockly.

  • fix: Para las confirmaciones que corrigen errores en Blockly.

  • release: Para las confirmaciones que se relacionan con el lanzamiento de una versión nueva.

Cambios rotundos

Las confirmaciones que realizan cambios rotundos deben agregar un ! después del tipo de confirmación. Los cambios rotundos son aquellos que pueden afectar a los desarrolladores que usan Blockly en sus apps, lo que los obliga a realizar trabajo adicional.

Por ejemplo: none fix!: return type of workspace.paste

Los cambios disruptivos pueden tener cualquiera de los tipos válidos anteriores.

Descripción

La descripción no puede estar vacía y debe tener menos de 256 caracteres.

Cuerpo

El cuerpo es opcional. Si se proporciona, debe haber una línea en blanco entre él y la descripción. Debe dividirse en líneas de no más de 256 caracteres.

Ten en cuenta que, por lo general, es recomendable incluir este tipo de información en la descripción de tu solicitud de extracción, además de hacerlo directamente en la confirmación.

El pie de página es opcional. Si se proporciona, debe haber una línea en blanco entre él y el cuerpo. Debe dividirse en líneas de no más de 256 caracteres.

Cómo corregir confirmaciones no convencionales

Si no usaste confirmaciones convencionales cuando realizaste las modificaciones, tienes dos opciones para corregir los mensajes, según la cantidad de confirmaciones que tengas:

  1. Si tu solicitud de extracción tiene varias confirmaciones, edita el título para que cumpla con los requisitos. Cuando se combine la solicitud de extracción, tus otras confirmaciones se comprimirán para que el título se convierta en el mensaje de confirmación.

  2. Si tu solicitud de extracción tiene una sola confirmación, modifica el mensaje de confirmación con git commit --amend y, luego, haz un envío forzado de tus cambios a tu bifurcación de Blockly. Esto actualizará automáticamente cualquier solicitud de extracción abierta asociada con esta rama. git push --force origin my-branch.