Articulo de referencia

Registro de cambios

Registro de cambios en la Wikipedia en alemán Un registro de cambios es una lista de los cambios realizados en un software que ha sido revisado a lo largo del tiempo, como un có...

Registro de cambios en la Wikipedia en alemán

Un registro de cambios es una lista de los cambios realizados en un software que ha sido revisado a lo largo del tiempo, como un código fuente o un producto . [ 1 ]

Un registro de cambios puede ser un documento organizado. El autor del registro de cambios puede presentar la información de forma que sea fácil de entender y consultar. En un proyecto de software y en una versión de software , un registro de cambios suele organizarse en correcciones de errores y nuevas funcionalidades.

Un registro de cambios también puede ser un informe generado que incluye todos los cambios sin importar la facilidad de consumo o comprensión. Normalmente, un sistema de control de versiones como Git puede generar una lista de cambios de código, pero algunos consideran que esto no es útil y prefieren una lista seleccionada de cambios notables. [ 2 ] [ 3 ] Otro ejemplo de registro de cambios generado es el de una wiki típica que enumera los cambios realizados en cada artículo. En particular, Wikipedia ofrece esta función a través del enlace "Ver historial" en la página de cada artículo. [ 4 ]

El nombre de un archivo changelog varía. Los nombres comúnmente utilizados incluyen "CHANGELOG", "CHANGES" e "HISTORY". [ 3 ] La convención de nomenclatura de GNU Automake es "ChangeLog". [ 5 ] A veces, ese nombre de archivo incluye una extensión para indicar el formato del archivo , como ".txt" para texto , ".md" para Markdown o ".rst" para reStructuredText . A menudo, un código fuente , especialmente un proyecto de software de código abierto , incluye un archivo changelog en el nivel superior de un árbol de directorios de distribución .

En ocasiones, la información sobre los cambios recientes se incluye en una versión del producto. Esto puede presentarse como una función o un archivo con nombres como "noticias", "cambios recientes" o " notas de la versión ".

Formato

En general, el formato de un registro de cambios varía considerablemente, pero los estándares de codificación GNU especifican que un registro de cambios se organiza en bloques que identifican cuándo se realizó un cambio y quién lo realizó (nombre y dirección de correo electrónico), y describen cada cambio dentro de una función o archivo. Entre la fecha y el nombre, y entre el nombre y la dirección de correo electrónico, hay dos espacios. Es común encerrar la dirección de correo electrónico entre < y > . El editor Emacs crea dichas entradas al crear entradas adicionales en el registro de cambios. [ 6 ]

Por ejemplo:

AAAA-MM-DD ␣␣ John Doe ␣␣ <johndoe@example.com > * myfile.ext (myfunction): mis cambios realizados cambios adicionales. * myfile.ext (unrelated_change): mis cambios realizados a myfile.ext pero completamente ajeno a lo anterior. * anotherfile.ext (somefunction): más cambios realizados por mí. 

Véase también

  • Control de cambios : proceso que garantiza que los cambios en un producto o sistema estén controlados. 
  • Diff : comando de shell para comparar el contenido de los archivos. 
  • Archivo de registro : registro cronológico de las operaciones de procesamiento de datos informáticos. Páginas que muestran breves descripciones de los destinos de redirección. 
  • README – Archivo de información del software 
  • Hoja de ruta tecnológica – Técnica de planificación 
  • Fuente web – Formato de datos 

Notas

  1. Lewko, Caroline (2021). Relaciones con desarrolladores: Cómo crear y desarrollar un programa de desarrollo exitoso . Berkeley, CA: Apress LP, págs. 189–194 . ISBN  978-1484271636.
  2. Atlassian. "¿Qué es el control de versiones | Tutorial de Git de Atlassian?" . Atlassian . Consultado el 17 de febrero de 2022 .
  3. 1 2 "Mantén un registro de cambios" . keepachangelog.com .
  4. Ayuda:Historial de la página
  5. El manual de GNU automake .
  6. "Estándares de codificación GNU: Estilo de los registros de cambios" . Gnu.org . Consultado el 3 de septiembre de 2019 .
  • Estándares de codificación GNU: Registros de cambios
  • Mantén un REGISTRO DE CAMBIOS