Un ChangeLog es un fichero que contiene la cronología de los cambios más significativos realizados en cada versión de un proyecto.
Tanto el desarrollador del software, como el usuario final necesitan saber que cambios y mejoras han sido realizadas en cada versión de un proyecto.
En cada ChangeLog nos encontraremos:
- Una entrada para cada versión.
- Todos los cambios deben ser agrupados.
- La última versión de proyecto será la primera en mostrarse.
- Cada revisión debe mostrar siempre su fecha.
Tipos de Cambios
Los cambios pueden ser de diferentes tipos:
- Added: Inclusión de nuevas funcionalidades.
- Changed: Cambios en funcionalidades ya existentes.
- Deprecated: Funcionalidades obsoletas y que serán eliminadas en futuras versiones.
- Removed: Funcionalidades ya eliminadas.
- Fixed: Correciones.
- Security: Avisos de posibles vulnerabilidades.
Incluye una sección unreleased con los cambios que necesitan ser realizados.
Esto nos permite ahorrar tiempo a la hora de hacer un seguimiento de los cambios y de incluirlos en una nueva versión.
Lenguaje de Marcado (MarkDown)
Los ficheros ChangeLog suelen tener extensión .md que son las siglas de Markdown Language
Los encabezados se incluyen usando almohadillas
|
1 2 3 4 5 6 |
# encabezado 1 ## encabezado 2 ### encabezado 3 #### encabezado 4 ##### encabezado 5 ###### encabezado 6 |
Para incluir citas usaremos el símbolo mayor
|
1 |
> En esta vida siempre hay alguien que sabe más que tu. - Anónimo |
Para enfatizar textos usaremos asteriscos
|
1 2 |
*texto en cursiva* **texto en negrita** |
Si necesitamos incluir código usaremos el acento grave, seguido del lenguaje utilizado entre corchetes
|
1 2 3 |
```[git] $ git archive master | gzip > lasted.tgz ``` |
Se pueden incluir listas usando asteriscos o numeraciones
|
1 2 3 4 5 6 7 |
* Elemento 1 * Elemento 2 * Elemento 3 1. Elemento 1 2. Elemento 2 3. Elemento 3 |
Para crear enlaces lo haríamos de la siguiente forma:
|
1 2 3 |
# Author Info - [Web](https://www.artegrafico.net "José Luis Rojo") - [Email](mailto:jose@artegrafico.net "jose@artegrafico.net") |
Si incluimos un símbolo de admiración al inicio indicaremos que es una imagen
|
1 |
 |
Veamos un ejemplo de CHANGELOG.md
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
# Responsive Side Menu All notable changes to this project will be documented in this file. ## [1.0.4] - 2019-01-25 ----------------- ### Added - added search input ### Changed - responsive design on tablets with orientation portrait ### Removed ### Fixed ## [1.0.3] - 2019-01-22 ----------------- ### Added - added new social menu ## [1.0.0] - 2019-01-19 ----------------- ### Added - Desktop and Responsive Menu - Multilevel dropdown Menu |
Más información sobre la creación de un ChangeLog
