Este documento está dirigido a los colaboradores de Bazel.
Las descripciones de confirmación en Bazel incluyen una etiqueta RELNOTES: seguida de una nota de lanzamiento. El equipo de Bazel lo usa para hacer un seguimiento de los cambios en cada versión y escribir
el anuncio de lanzamiento.
Descripción general
¿Tu cambio es una corrección de errores? En ese caso, no necesitas una nota de la versión. Incluye una referencia al problema de GitHub.
Si el cambio agrega, quita o cambia Bazel de una manera visible para el usuario, puede ser ventajoso mencionarlo.
Si el cambio es significativo, primero sigue la política del documento de diseño.
Lineamientos
Los usuarios leerán las notas de la versión, por lo que deben ser breves (idealmente, una oración), evita la jerga (terminología interna de Bazel), debes centrarte en lo que se trata el cambio.
Incluye un vínculo a la documentación relevante. Casi todas las notas de la versión deben contienen un vínculo. Si la descripción menciona una marca, una función, el nombre de un comando, es probable que los usuarios quieran saber más al respecto.
Usa acentos graves alrededor del código, los símbolos, las marcas o cualquier palabra que contenga un guion bajo.
No te limites a copiar y pegar descripciones de errores. A menudo, son crípticos y solo tienen sentido para nosotros, lo que deja al usuario con la cabeza en la mano. Las notas de la versión son para explicar qué cambió y por qué con un lenguaje comprensible para los usuarios.
Usa siempre el tiempo presente y el formato "Bazel ahora admite Y" o "X ahora hace Z". No queremos que nuestras notas de la versión suenen como entradas de errores. Todas las entradas de las notas de lanzamiento deben ser informativas y usar un estilo y un lenguaje coherentes.
Si se da de baja o se quita algo, usa "X se dio de baja" o "X se quitó". No se debe usar "se quita" o "se quitó".
Si Bazel ahora hace algo de forma diferente, usa "X ahora $newBehavior en lugar de $oldBehavior" en tiempo presente. Esto le permite al usuario saber en detalle qué puede esperar cuando usa la nueva versión.
Si Bazel ahora admite o ya no admite algo, usa "Bazel ahora admite/ya no admite X".
Explica por qué algo se quitó, dejó de estar disponible o cambió. Una oración es suficiente, pero queremos que el usuario pueda evaluar el impacto en sus compilaciones.
NO hagas promesas sobre funcionalidades futuras. Evita “esta marca se quitada" o "esto se cambiará". Genera incertidumbre. Lo primero el usuario se preguntará "¿cuándo?" y no queremos que empiecen a preocuparse por y sus compilaciones actuales fallan en un momento desconocido.
Proceso
Como parte del proceso de lanzamiento, recopilamos las etiquetas RELNOTES de cada confirmación. Copiamos todo en un Documento de Google, donde revisamos, editamos y organizamos las notas.
El administrador de versiones envía un correo electrónico a la bazel-dev. Se invita a los colaboradores de Bazel a contribuir con el documento y asegurarse de que sus cambios se reflejen correctamente en el anuncio.
Luego, el anuncio se enviará a Bazel. blog, con la función bazel-blog de Terraform.