Registro de cambios - Changelog

Para obtener información sobre los registros de cambios de Wikipedia, consulte Ayuda: Historial de la página .

Un registro de cambios es un registro o registro de todos los cambios notables realizados en un proyecto. El proyecto es a menudo un sitio web o un proyecto de software, y el registro de cambios generalmente incluye registros de cambios como correcciones de errores, nuevas funciones, etc. Algunos proyectos de código abierto incluyen un registro de cambios como uno de los archivos de nivel superior en su distribución.

Históricamente, un registro de cambios ha incluido todos los cambios realizados en un proyecto. En cambio, el sitio "Keep a Changelog" aboga por que un registro de cambios no incluya todos los cambios, sino que debería contener "una lista curada y ordenada cronológicamente de cambios notables para cada versión de un proyecto" y no debería ser un "volcado" de un git log "porque esto no ayuda a nadie".

Aunque la convención de nomenclatura canónica para el archivo es ChangeLog , a veces se denomina alternativamente CAMBIOS o HISTORIA ( NOTICIAS suele ser un archivo diferente que refleja los cambios entre las versiones, no entre las confirmaciones). Otra convención es llamarlo CAMBIO . Algunos mantenedores de proyectos agregarán un sufijo .txt al nombre del archivo si el registro de cambios es texto sin formato , un sufijo .md si está en Markdown , o un sufijo .rst si está en reStructuredText .

Algunos sistemas de control de revisiones pueden generar la información relevante que se adapta como un registro de cambios si el objetivo es incluir todos los cambios.

Un registro de cambios de golang es sinónimo de un conjunto de cambios de código y la revisión del código asociado .

Formato

Los archivos de registro de cambios están organizados por párrafos, que definen un cambio único dentro de una función o archivo. Los estándares de codificación GNU recomiendan el siguiente formato: 

YYYY-MM-DD  John Doe  <johndoe@example.com>

    * myfile.ext (myfunction): my changes made
    additional changes

    * myfile.ext (unrelated_change): my changes made
    to myfile.ext but completely unrelated to the above

    * anotherfile.ext (somefunction): more changes

Tenga 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 entre <y>. La versión 9.0 crea dichas entradas al crear entradas de registro de cambios adicionales.

Registros de cambios en wikis

La mayoría del software wiki incluye registros de cambios como característica fundamental (a menudo denominada historial en este contexto). Por ejemplo, el enlace "Ver historial" en la parte superior de una entrada de Wikipedia enlaza con el registro de cambios de esa página. Esta función es vital para cumplir con los requisitos de atribución de algunas licencias de derechos de autor.

Registros de cambios de productos

Un registro de cambios de producto permite mantener a los clientes informados sobre las novedades. Ayuda a anunciar nuevas funciones, últimos lanzamientos y noticias relevantes directamente en la aplicación.

Ver también

Notas

enlaces externos