Plantilla de registro de cambios

Una plantilla de registro de cambios de proyectos de software que sigue las convenciones de Keep a Changelog.

# Plantilla de Registro de Cambios: El kit de herramientas esencial para la documentación profesional de proyectos Mantener un proyecto de software es más que simplemente escribir código; se trata de comunicar la evolución de su trabajo a sus usuarios, colaboradores y a usted mismo en el futuro. Sin embargo, para muchos desarrolladores, la tarea de actualizar un archivo CHANGELOG.md a menudo se relega a una idea de último momento o se olvida por completo en el calor del lanzamiento. "Changelog Template" es una extensión de Chrome diseñada para cerrar esta brecha, proporcionando un flujo de trabajo optimizado, intuitivo y profesional para mantener registros de cambios de alta calidad que siguen las convenciones estándar de la industria. ## El propósito central: Mejor comunicación a través de "Keep a Changelog" En esencia, Changelog Template está diseñado para ayudar a los proyectos de software a cumplir con las convenciones de "Keep a Changelog". Un buen registro de cambios es una lista seleccionada y ordenada cronológicamente de cambios notables para cada versión de un proyecto. No es un volcado sin procesar de commits de git; es un documento escrito para humanos. Al usar esta extensión, usted garantiza que el historial de su proyecto sea legible, organizado y útil. Ya sea que esté administrando un pequeño proyecto paralelo, una gran biblioteca de código abierto o un conjunto de herramientas internas, Changelog Template proporciona la estructura que necesita para mantener la transparencia y el profesionalismo sin añadir fricción a su ciclo de desarrollo. ## Un formato estandarizado en el que puede confiar La extensión está estrictamente alineada con el formato estándar de registro de cambios, lo que garantiza que su documentación se vea profesional y siga siendo compatible con el ecosistema más amplio. Cada entrada que crea se clasifica en uno de los seis tipos de cambio estándar recomendados por el proyecto "Keep a Changelog": 1. **Added (Añadido):** Para nuevas funciones que amplían las capacidades de su software. 2. **Changed (Cambiado):** Para cambios en la funcionalidad existente que alteran cómo funcionan las cosas. 3. **Deprecated (Obsoleto):** Para funciones que pronto se eliminarán, avisando a los usuarios para que migren. 4. **Removed (Eliminado):** Para funciones que se han retirado oficialmente de la base de código. 5. **Fixed (Corregido):** Para cualquier corrección de errores que resuelva problemas y mejore la estabilidad. 6. **Security (Seguridad):** Para parches críticos que abordan vulnerabilidades. Esta categorización ayuda a los usuarios a escanear rápidamente sus notas de lanzamiento para encontrar exactamente lo que necesitan, ya sea que busquen nuevas herramientas para usar o verifiquen si se ha solucionado un error específico. ## Guía sobre cómo escribir entradas impactantes Escribir una buena entrada de registro de cambios es una forma de arte. Requiere equilibrar la precisión técnica con la accesibilidad. Changelog Template no solo le da un cuadro de texto; proporciona el contexto y la guía necesarios para escribir entradas que importan. Abogamos por tres reglas simples: - **Use oraciones simples:** Sea conciso. Un punto claro por entrada es mejor que un párrafo denso. - **Use el tiempo pasado:** Está describiendo lo que *ha cambiado* (por ejemplo, "Se mejoró el rendimiento de búsqueda" en lugar de "Mejorar el rendimiento de búsqueda"). - **Adopte una perspectiva de usuario:** Escriba para la persona que usa su software, no para la persona que escribió el código. En lugar de decir "Se refactorizó el optimizador de consultas SQL", diga "Se mejoró el rendimiento de búsqueda en un 50%". La extensión incluso ayuda con la mecánica: capitaliza automáticamente sus entradas y se asegura de que terminen con un punto adecuado si lo olvida. ## Espacio de trabajo rico en funciones Changelog Template está repleto de funciones que hacen que la documentación se sienta como una parte natural de su flujo de trabajo: ### 1. Creación rápida de entradas La pestaña "Create" es su zona de aterrizaje. Seleccione su tipo de cambio, escriba su entrada y presione "Add to Unreleased". Es así de simple. No más cambios de contexto entre su IDE y un archivo Markdown solo para anotar una actualización rápida. ### 2. Gestión persistente de "Unreleased" Una de las características más potentes de un buen registro de cambios es la sección "Unreleased". Esto actúa como un área de preparación para todos los cambios que ha realizado desde la última versión oficial. Changelog Template gestiona esta sección por usted, manteniendo sus entradas en el almacenamiento local para que estén listas cada vez que abra la extensión. ### 3. Referencia de Versionado Semántico (SemVer) El versionado no debería ser un juego de adivinanzas. Nuestra pestaña "Reference" incluye una guía de inicio rápido sobre Versionado Semántico (SemVer), ayudándole a decidir si su próximo lanzamiento debería ser una versión Mayor, Menor o de Parche: - **MAJOR (MAYOR):** Para cambios incompatibles en la API. - **MINOR (MENOR):** Para añadir funcionalidad de manera compatible con versiones anteriores. - **PATCH (PARCHE):** Para correcciones de errores compatibles con versiones anteriores. ### 4. Referencia de herramientas de automatización Para los equipos listos para dar el siguiente paso, proporcionamos punteros a herramientas de automatización estándar de la industria como `standard-version`, `release-it` y `semantic-release`. Estas herramientas trabajan de la mano con el formato Markdown generado por nuestra extensión para automatizar todo su proceso de lanzamiento. ### 5. Copia con un clic y exportación a Markdown Una vez que esté listo para actualizar su archivo, puede copiar la sección "Unreleased" como Markdown formateado con un solo clic. ¿Necesita iniciar un nuevo proyecto? Use nuestra "Full CHANGELOG.md Starter Template" para generar un archivo completo de plantilla que incluya los encabezados y enlaces necesarios. ## Por qué es importante un buen registro de cambios Un registro de cambios bien mantenido es más que una simple lista de actualizaciones; es una señal de un proyecto saludable y maduro. Crea **transparencia** al mostrar a los usuarios que el proyecto se mantiene activamente. Facilita la **comunicación** al resaltar cambios importantes que de otro modo podrían quedar enterrados en cientos de mensajes de confirmación. Sobre todo, demuestra **profesionalismo**. Cuando un usuario ve un CHANGELOG.md limpio y organizado, sabe que puede confiar en el proyecto y en el desarrollador detrás de él. ## ¿Para quién es esto? - **Desarrolladores independientes:** Mantenga sus proyectos paralelos organizados y evite el momento de "¿qué hice hace tres meses?". - **Pequeños equipos:** Asegúrese de que todos estén en la misma página con respecto al progreso del proyecto sin necesidad de tableros de Jira complejos para cada actualización menor. - **Colaboradores de código abierto:** Haga que su proyecto sea más atractivo para los nuevos usuarios proporcionando notas de lanzamiento claras y fáciles de leer. ## Facilidad de uso: sin configuración, sin complicaciones Changelog Template está diseñado para ser invisible hasta que lo necesite. No hay una configuración compleja, ni cuentas externas que crear, ni claves API que gestionar. Utiliza el almacenamiento local de Chrome para mantener sus datos privados y accesibles solo en su máquina. La interfaz de usuario es minimalista y receptiva, encajando perfectamente en la barra lateral o el área emergente de su navegador. Deje de permitir que la documentación de su proyecto se quede atrás. Empiece a usar **Changelog Template** hoy mismo y dele a su software el historial profesional que merece.