Guías de proyectos

Plantilla de notas de versión de GitHub para proyectos de código abierto

Unas buenas notas de versión indican al usuario si debe actualizar y qué hacer a continuación. Una lista de solicitudes de cambios integradas aporta evidencia útil, pero rara vez explica toda la experiencia de actualización. Añade el impacto para el usuario y las acciones necesarias antes de publicar.

Equipo editorial de GitHubStart · Actualizado

Empieza con una plantilla centrada en el usuario

Sustituye cada campo entre corchetes por información verificada. Elimina las secciones irrelevantes en lugar de inventar funciones. Si no hace falta ninguna acción para actualizar, indícalo explícitamente tras comprobar la ruta de actualización compatible.

# [Versión] — [Fecha de publicación]

## Novedades destacadas
- [Mejora visible para el usuario y a quién beneficia]

## Actualización
- Desde: [versión anterior compatible]
- Acción: [migración necesaria o ninguna acción necesaria]
- Verificación: [cómo confirmar una actualización correcta]

## Cambios incompatibles
- [Comportamiento modificado, usuarios afectados y enlace de migración]

## Correcciones
- [Problema resuelto y enlace a la incidencia o solicitud de cambios]

## Problemas conocidos
- [Limitación pendiente y solución alternativa]

## Colaboradores
[Reconoce a los colaboradores y enlaza el registro de cambios completo]

Convierte las notas generadas en una explicación legible

GitHub puede generar notas con las solicitudes de cambios integradas, los colaboradores y un enlace al registro de cambios completo. Trata ese resultado como un borrador. Comprueba el alcance de la versión, elimina entradas irrelevantes y agrupa los cambios según las tareas que realizan tus usuarios.

Por ejemplo, «Corregir caso límite del analizador» orienta poco. Si es exacto, explica que ahora se importan correctamente los archivos CSV con una última columna vacía y enlaza la corrección para los detalles técnicos. No afirmes que se han resuelto todos los problemas de análisis si solo cambió un caso.

Revisa la ruta de actualización antes del anuncio

Prueba la actualización documentada desde una versión anterior compatible. Comprueba los enlaces de descarga y que la documentación corresponda a la versión. Distingue una versión preliminar de una estable y facilita encontrar las limitaciones pendientes.

Publica la información de la versión antes de enlazarla en una publicación de la comunidad. Usa el anuncio para destacar una mejora significativa, dejando las notas de versión como referencia detallada. Recoge las preguntas posteriores y aclara las instrucciones cuando sea necesario.

Preguntas frecuentes

¿Las notas de versión son lo mismo que un registro de cambios?

Se solapan. Un registro de cambios recoge modificaciones a lo largo del tiempo; las notas de versión explican una versión concreta y su efecto sobre los usuarios. Enlázalos para que el lector pueda pasar del resumen a los detalles.

¿Puedo publicar las notas generadas automáticamente sin cambios?

Revísalas primero. Los títulos de las solicitudes de cambios generados pueden omitir pasos de migración, el impacto para el usuario o problemas conocidos.

¿Cada pequeño cambio de código debería aparecer entre las novedades destacadas?

No. Destaca los cambios que importan a los usuarios y conserva el historial técnico detallado en el registro de cambios enlazado.

Referencias