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 notas de la versión. El proyecto de Blockly usa confirmaciones 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 central de Blockly tiene un linter de confirmación para aplicar esto. Si tu solicitud de extracción tiene varias confirmaciones, linter verificará el título. Si tiene una sola confirmación, verificará esa confirmación. Lo mejor es que tus confirmaciones individuales y el título de la solicitud de extracción sigan estos lineamientos.

Tipo

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

tarea
Para confirmaciones que completan tareas de rutina o automatizadas, como la actualización de dependencias.
dar de baja
Para las confirmaciones que dan de baja la funcionalidad.
feat
Para confirmaciones que agregan funcionalidades nuevas a Blockly.
fix
Para confirmaciones que corrigen errores en Blockly.
versión
Para confirmaciones relacionadas 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 provocar que los desarrolladores usen Blockly en sus apps y que deban hacer un trabajo adicional.

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

Los cambios rotundos podrían tener cualquiera de los tipos válidos mencionados anteriormente.

Descripción

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

Body

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, se recomienda incluir este tipo de información en la descripción de tu solicitud de extracción, además de o en lugar 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. Se debe dividir en líneas de no más de 256 caracteres.

Corrige confirmaciones no convencionales

Si no usaste confirmaciones convencionales cuando hiciste las modificaciones, hay 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 de la solicitud de extracción para cumplir con los requisitos. Cuando se combina la solicitud de extracción, las demás confirmaciones se aprietan 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 mediante git commit --amend y, luego, fuerza el envío de los cambios a la bifurcación de Blockly. Esto actualizará automáticamente cualquier solicitud de extracción abierta asociada con esta rama. git push --force origin my-branch.