Directrices para los compromisos

Hacemos cumplir ciertas normas sobre compromisos con los siguientes objetivos en mente:

  • Ser capaz de autogenerar de manera confiable el CHANGELOG.mdsin ningún ser humano
    intervención.
  • Ser capaz de aumentar de forma automática y correcta el número de versión de semver
    Basado en lo que se hizo desde el último lanzamiento.
  • Ser capaz de obtener una visión rápida de lo que pasó con el proyecto mirando
    sobre la historia del commit.
  • Ser capaz de hacer referencia automáticamente a los cambios relevantes de una dependencia
    actualización.

Estructura de compromiso ​​

Cada mensaje de confirmación necesita especificar el tipo semver. Que puede ser patch|minor|major.
Consulte la especificación de versiones semánticas para una explicación más detallada del significado de estos tipos.
Ver Balena commit directrices para más información sobre toda la estructura de compromiso.

<semver-type>: <subject>

o o

<subject>
<BLANK LINE>
<details>
<BLANK LINE>
Change-Type: <semver-type>

El sujeto no debe contener más de 70 caracteres, incluyendo el tipo y
alcance, y el cuerpo debe estar envuelto en 72 caracteres.

Etiquetas ​​

Esta etiqueta puede utilizarse para referirse a un recurso que es relevante para la comisión,
y puede repetirse varias veces en el mismo commit.

Los ejemplos de recursos incluyen:

  • Un enlace para tirar de las solicitudes.
  • Un enlace a un asunto de GitHub.
  • Un enlace a un sitio web que proporciona información útil.
  • Un hash de confirmación.

Su recomendado para evitar URLs relativas, y que incluyas el todo
comprometerse a evitar cualquier posible ambiguedad en el futuro.

Si el tipo de confirmación es igual upgrade, esta etiqueta debe estar presente, y debe
enlace a la sección CHANGELOG de la dependencia que describe los cambios
introducido de la versión previamente utilizada.

Ejemplos:

See: https://github.com/xxx/yyy/
See: 49d89b4acebd80838303b011d30517cd6229fdbe
Link: https://github.com/xxx/yyy/issues/zzz

Closes: <url>/ Fixes: <url>​​

Esta etiqueta se utiliza para hacer que GitHub cierre el número de referencia automáticamente cuando
el compromiso se fusiona.

Su recomendado para proporcionar la URL absoluta al tema de GitHub más bien
que simplemente escribir el ID prefijo por una etiqueta de hash para la comodidad al navegar
la historia de compromiso fuera de la interfaz web de GitHub.

Una confirmación puede incluir múltiples instancias de esta etiqueta.

Ejemplos:

Closes: https://github.com/balena-io/etcher/issues/XXX
Fixes: https://github.com/balena-io/etcher/issues/XXX

Deja un comentario