Uso de Conventional Commits para la Escritura de Texto

La escritura de textos, especialmente aquellos escritos en LaTeX, puede beneficiarse del uso de sistemas de control de versiones como Git. La integración con herramientas como Overleaf y GitHub no solo facilita la colaboración, sino que también asegura un seguimiento detallado de todos los cambios. En este blog, proponemos el uso de Conventional Commits adaptados específicamente para la escritura de textos, proporcionando un esquema claro y estructurado para el mantenimiento y desarrollo del contenido.

¿Por qué usar Git para la escritura de textos?

El uso de Git en la escritura de textos proporciona múltiples beneficios:

  • Historial de Cambios: Permite mantener un registro detallado de todas las modificaciones, facilitando la revisión y restauración de versiones anteriores.
  • Colaboración: Múltiples autores pueden trabajar simultáneamente en diferentes partes del libro sin conflictos, utilizando ramas y solicitudes de extracción para integrar cambios.
  • Automatización: Integraciones con servicios como GitHub Actions pueden automatizar tareas repetitivas, como la generación de PDFs.
  • Seguridad: El control de versiones protege el trabajo frente a pérdidas accidentales, ya que cada cambio está respaldado en el repositorio.

Integración con Overleaf y GitHub

Overleaf es una herramienta popular para escribir documentos en LaTeX que ofrece sincronización con GitHub (ver aquí), permitiendo aprovechar lo mejor de ambos mundos:

  1. Sincronización: Los cambios realizados en Overleaf se pueden sincronizar con un repositorio de GitHub.
  2. Colaboración en Tiempo Real: Overleaf permite la edición colaborativa en tiempo real, mientras que GitHub gestiona el control de versiones.
  3. Automatización de Flujos de Trabajo: GitHub Actions puede automatizar la compilación de documentos y otros procesos.

Propuesta de Uso de Conventional Commits para Escritura de textos

Aquí, presentamos una tabla con la propuesta de convenciones para commits en proyectos de escritura de textos, adaptada de la estructura de Conventional Commits:

Tipo Emoji Descripción Ejemplo Uso en Programación Ejemplo en Programación
feat Agregar nuevo contenido significativo al texto feat: se agrega capítulo sobre espacios vectoriales Agregar nueva funcionalidad feat: se añade nueva funcionalidad de autenticación
fix 🐛 Correcciones de errores en el contenido fix: se corrigen errores gramaticales en el capítulo de matrices Corregir errores fix: se corrigen errores de validación en el formulario
docs 📚 Actualizaciones en la documentación adicional del libro docs: se actualiza índice y tabla de contenido Actualizar documentación docs: se actualiza el archivo README
style 🎨 Cambios en la presentación o estilo del texto style: se ajusta el formato de encabezados en el capítulo de determinantes Cambios de formato o estilo sin afectar el código style: se ajusta el formato del código según las guías de estilo
refactor ♻️ Reorganización de contenido sin cambiar su significado refactor: se reorganizan secciones del capítulo de transformaciones lineales Mejorar el código sin cambiar su funcionalidad refactor: se refactoriza la lógica de negocio
perf ⚡️ Mejoras de rendimiento en el contenido perf: se optimiza tamaño de imágenes en el capítulo de valores propios Mejorar rendimiento perf: se mejora el rendimiento de la consulta SQL
test 🚨 Modificaciones en ejemplos, ejercicios o pruebas test: se agregan nuevos ejercicios al final del capítulo de sistemas de ecuaciones lineales Añadir o modificar pruebas test: se añaden pruebas unitarias para el módulo de usuarios
build 📦 Cambios que afectan el sistema de construcción o dependencias externas build: se actualiza plantilla de estilo para capítulos Cambios en el sistema de construcción build: se actualizan dependencias de npm
chore 🔧 Tareas de mantenimiento y soporte no relacionadas con el contenido principal chore: se ajusta el formato de las citas bibliográficas según el estilo APA Tareas de mantenimiento chore: se actualiza .gitignore
revert Revertir un commit anterior revert: se revierte cambios en el capítulo 2 Revertir cambios revert: se revierte commit de refactorización

Uno de los tipos de commits que podrían ser de más uso en el mantenimiento de un proyecto de escritura de texto, es chore. Aquí algunos ejemplos que podrían ocurrir:

  • chore: se elimina archivos temporales generados durante la edición
  • chore: se actualiza archivo de configuración de citación bibliográfica
  • chore: se reestructuran carpetas del proyecto para mejor organización
  • chore: actualizar archivo de referencias bibliográficas con nuevas entradas

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *