Changelog
| ||||||
Changelog: es un registro de cambios o un archivo que lista los cambios hechos a un proyecto informático desde su última versión, incluyendo habitualmente corrección de errores malintencionados y nuevas características.
Sumario
- 1 Otros nombres alternativos que recibe el Changelog
- 2 Objetivo del Changelog
- 3 Producto Changelog
- 4 Formato
- 5 Utilidad del Changelog
- 6 Principios rectores
- 7 Tipos de cambios que se pueden realizar en el Changelog
- 8 Para mantener el Changelog
- 9 Propósitos
- 10 Cambios recientes
- 11 Ejemplos donde se puede aplica
- 12 Fuente
Otros nombres alternativos que recibe el Changelog
- CHANGES (cambios)
- HISTORY (historial)
- (NEWS -novedades- suele ser un archivo diferente que refleja los cambios entre una publicación y otra, no entre commits), algunos administradores de proyectos le añaden la extensión .txt como apéndice al archivo, además
algunos sistemas de control de versiones pueden generar la información relevante para este tipo de documentos automáticamente.
Objetivo del Changelog
Se produce para el uso de consumidores o desarrolladores, para que estos estén actualizados sobre lo que brinda el software, los cambios que él se produce, por qué y cómo.
Producto Changelog
Un registro de cambios del producto permite mantener a los clientes informados sobre las novedades. Ayuda a anunciar nuevas funciones, los últimos lanzamientos y las noticias relevantes directamente en la aplicación.
Formato
Los archivos de registro de cambios se organizan por párrafos, que definen un cambio único dentro de una función o archivo. Los estándares de codificación GNU recomiendan el formato,se debe tener en cuenta que entre la fecha y el nombre, y nuevamente entre el nombre y la dirección de correo electrónico, hay dos espacios cada uno. Es común incluir la dirección de correo electrónico en <y>. El Editor de Emacs crea tales entradas cuando crea entradas de registro de cambios adicionales.
Utilidad del Changelog
Posibilita que los usuarios y colaboradores les resulte más fácil ver con precisión qué cambios notables se han realizado entre cada versión del proyecto.
Principios rectores
- Los changelogs son para humanos, no para máquinas.
- Debe haber una entrada para cada versión única.
- Los mismos tipos de cambios deben agruparse.
- Las versiones y secciones deben ser vinculables.
- La última versión es lo primero.
- Se muestra la fecha de lanzamiento de cada versión.
Tipos de cambios que se pueden realizar en el Changelog
- Añadir nuevas características.
- Cambiado por cambios en la funcionalidad existente.
- En desuso para las características que pronto serán eliminadas.
- Eliminado por ahora las características eliminadas.
- Corregido para cualquier corrección de errores.
- Seguridad en caso de vulnerabilidades.
Para mantener el Changelog
- Mantenga una sección inédita en la parte superior para rastrear los próximos cambios.
Propósitos
- La gente puede ver qué cambios pueden esperar en los próximos lanzamientos.
- En el momento del lanzamiento, puede mover los cambios de la sección no publicados a una nueva sección de la versión de lanzamiento.
Cambios recientes
A finales de febrero de 2019.
Ejemplos donde se puede aplica
En un sitio web o un proyecto de software.
Visite también
Fuente
https://keepachangelog.com/en/1.0.0/ https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md https://documentation.cpanel.net/display/CL/Change+Logs. https://owncloud.org/changelog/ https://secure.phabricator.com/w/changelog/
