Este documento está dirigido a colaboradores de Bazel.
Las descripciones de confirmación en Bazel incluyen una etiqueta RELNOTES: seguida de una nota de la
versión. El equipo de Bazel la usa para hacer un seguimiento de los cambios en cada versión y escribir
el anuncio de la versión.
Descripción general
¿El cambio contiene 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 beneficioso mencionarlo.
Si el cambio es significativo, sigue primero la política del documento de diseño.
Lineamientos
Nuestros usuarios leerán las notas de la versión, por lo que deben ser breves (idealmente una oración), evitar la jerga (terminología interna de Bazel) y centrarse en el cambio.
Incluye un vínculo a la documentación relevante. Casi todas las notas de la versión deben contener un vínculo. Si la descripción menciona una marca, una función o un nombre de comando, es probable que los usuarios quieran saber más al respecto.
Usa comillas inversas para escribir código, símbolos, marcas o cualquier palabra que contenga un guion bajo.
No solo copies y pegues descripciones de errores. A menudo, son crípticas y solo tienen sentido para nosotros y hacen que el usuario se rasque la cabeza. El objetivo de las notas de la versión es explicar qué cambió y por qué en un lenguaje comprensible para el usuario.
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 la versión deben ser informativas y usar un estilo y un lenguaje coherentes.
Si algo dejó de estar disponible o se quitó, usa "X dejó de estar disponible" o "X se quitó". No "se quitó" ni "se quitó".
Si Bazel hace algo diferente ahora, usa "X now $newBehavior en lugar de $oldBehavior" en tiempo presente. Esto le permite al usuario saber en detalle qué esperar cuando use la nueva versión.
Si Bazel ahora admite algo o ya no lo admite, usa "Bazel ahora admite X/ya no admite X".
Explicar 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 quitará" o "esto se cambiará". Presenta incertidumbre. Lo primero que se preguntará el usuario es “¿cuándo?” y no queremos que se preocupe por la falla de sus compilaciones actuales 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 en el que revisamos, editamos y organizamos las notas.
El administrador de versiones envía un correo electrónico a la lista de distribución de bazel-dev. Se invita a los colaboradores de Bazel a colaborar en el documento y asegurarse de que sus cambios se reflejen de forma correcta en el anuncio.
Más adelante, el anuncio se enviará al blog de Bazel mediante el repositorio de bazel-blog.