Plantilla de Changelog

Resumen

Un changelog es una lista curada y ordenada cronológicamente de los cambios notables de cada versión de un proyecto. Ayuda a usuarios y colaboradores a entender qué cambió entre releases.

Cuándo Usar

• Mantienes una librería, framework o aplicación con releases versionados
• Necesitas comunicar breaking changes a los consumidores
• Quieres automatizar la generación de notas de release

Plantilla

# Changelog

Todos los cambios notables de este proyecto se documentarán en este archivo.

El formato se basa en [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
y este proyecto sigue [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Nuevas funcionalidades

### Changed
- Cambios en funcionalidad existente

### Deprecated
- Funcionalidades que se eliminarán próximamente

### Removed
- Funcionalidades eliminadas en esta versión

### Fixed
- Correcciones de bugs

### Security
- Correcciones de vulnerabilidades

## [1.0.0] - YYYY-MM-DD

### Added
- Release inicial con funcionalidad core

Categorías Explicadas

Categoría	Uso
Added	Nuevas funcionalidades
Changed	Cambios en funcionalidad existente
Deprecated	Funcionalidades marcadas para eliminación
Removed	Funcionalidades eliminadas en esta release
Fixed	Correcciones de bugs
Security	Correcciones de vulnerabilidades de seguridad

Buenas Prácticas

• Fecha cada release usando formato ISO 8601 (YYYY-MM-DD)
• Agrupa cambios por categoría dentro de cada release
• Enlaza a issues/PRs cuando aplique
• Menciona breaking changes prominentemente
• Mantén una sección Unreleased al inicio para cambios próximos

Errores Comunes

• Volcado de git log: Un changelog es curado, no un log raw de git
• Fechas faltantes: Cada release debe tener fecha
• Olvidar la sección Unreleased: Ayuda a los usuarios a ver lo que viene

Preguntas Frecuentes

Qué formato debería seguir un changelog?

Usa el formato Keep a Changelog con categorías: Added, Changed, Deprecated, Removed, Fixed y Security. Fecha cada release en formato ISO 8601 y enlaza a issues o PRs cuando aplique.

Debería incluir cada commit en el changelog?

No. Un changelog es curado, no un log raw de git. Incluye solo cambios notables que afecten a usuarios: nuevas features, bug fixes, breaking changes y parches de seguridad.

Qué es el versionado semántico?

Semantic Versioning (SemVer) usa el formato MAJOR.MINOR.PATCH: incrementa MAJOR para breaking changes, MINOR para nuevas features y PATCH para bug fixes.