🔍 Verificaciones previas
🧩 Tipo de mejora
✨ Descripción de la propuesta
Actualmente, el proyecto no contempla una guía clara sobre cómo instalarlo, configurarlo y comprender su funcionamiento interno (estructura de carpetas e interacción entre estas), lo que podría dificultar que nuevos contribuidores participen fácilmente.
Sugiero considerar la incorporación de un archivo CONTRIBUTING.md que incluya una guía de instalación, una descripción general de la arquitectura del proyecto y lineamientos básicos para contribuir.
Dado que es un proyecto que puede recibir mejoras en aspectos gramaticales, ejemplos y formato —los cuales no requieren necesariamente conocimientos de programación—, la inclusión de este archivo ayudaría a reducir la barrera de entrada y facilitar la participación de nuevos aportantes.
🎯 Problema que resuelve
La ausencia de una guía clara de instalación, configuración y funcionamiento interno del proyecto genera una barrera de entrada para nuevos contribuidores, especialmente para aquellos que desean aportar en aspectos como contenido en Markdown, redacción o estilos.
Esto puede derivar en:
Dificultad para levantar el proyecto localmente
Falta de comprensión de la estructura y organización del código
Incertidumbre sobre cómo y dónde realizar cambios
Menor participación de contribuidores no técnicos
👤 Caso de uso
Un nuevo contribuidor desea mejorar el contenido del proyecto, por ejemplo corrigiendo errores gramaticales, agregando ejemplos o ajustando estilos.
Al intentar participar, no encuentra una guía clara sobre cómo instalar y ejecutar el proyecto localmente, ni sobre la estructura de carpetas o el flujo de trabajo para realizar cambios. Esto genera incertidumbre y dificulta su contribución.
Con la incorporación de un archivo CONTRIBUTING.md, el contribuidor podría:
- Seguir una guía paso a paso para instalar y ejecutar el proyecto
- Entender rápidamente dónde realizar cambios en Markdown o estilos
- Aplicar buenas prácticas básicas para contribuir
- Realizar su aporte de forma autónoma y eficiente
💡 Solución propuesta
Agregar un archivo CONTRIBUTING.md en la raíz del proyecto con:
Guía básica de instalación y ejecución
Descripción general de la estructura del proyecto
Indicaciones para editar Markdown y estilos
Opcionalmente, enlazarlo desde el README.md para mayor visibilidad.
Esta mejora se limita a documentación y no requiere cambios en la lógica del proyecto.
🚀 Impacto esperado
Este cambio beneficiará principalmente a nuevos contribuidores, facilitando su incorporación al proyecto.
Permitirá:
Reducir la barrera de entrada
Aumentar la participación, incluso de usuarios no técnicos
Mejorar la calidad del contenido (Markdown, redacción y estilos)
En conjunto, contribuirá a un crecimiento más activo y accesible del proyecto.
🔍 Alternativas consideradas
Se consideró incluir esta información únicamente en el README.md, pero esto podría sobrecargarlo y dificultar su lectura.
✅ Criterios de aceptación
- Existe un archivo CONTRIBUTING.md en la raíz del proyecto
- Incluye instrucciones claras para instalar y ejecutar el proyecto
- Describe de forma general la estructura del proyecto
- Explica cómo realizar contribuciones en Markdown y estilos
- Está enlazado desde el README.md
- Un nuevo contribuidor puede seguir la guía sin ayuda externa
🤝 ¿Te gustaría contribuir con esto?
Puedo ayudar a probarlo o revisarlo
📎 Recursos adicionales
No response
🔍 Verificaciones previas
🧩 Tipo de mejora
✨ Descripción de la propuesta
Actualmente, el proyecto no contempla una guía clara sobre cómo instalarlo, configurarlo y comprender su funcionamiento interno (estructura de carpetas e interacción entre estas), lo que podría dificultar que nuevos contribuidores participen fácilmente.
Sugiero considerar la incorporación de un archivo
CONTRIBUTING.mdque incluya una guía de instalación, una descripción general de la arquitectura del proyecto y lineamientos básicos para contribuir.Dado que es un proyecto que puede recibir mejoras en aspectos gramaticales, ejemplos y formato —los cuales no requieren necesariamente conocimientos de programación—, la inclusión de este archivo ayudaría a reducir la barrera de entrada y facilitar la participación de nuevos aportantes.
🎯 Problema que resuelve
La ausencia de una guía clara de instalación, configuración y funcionamiento interno del proyecto genera una barrera de entrada para nuevos contribuidores, especialmente para aquellos que desean aportar en aspectos como contenido en Markdown, redacción o estilos.
Esto puede derivar en:
Dificultad para levantar el proyecto localmente
Falta de comprensión de la estructura y organización del código
Incertidumbre sobre cómo y dónde realizar cambios
Menor participación de contribuidores no técnicos
👤 Caso de uso
Un nuevo contribuidor desea mejorar el contenido del proyecto, por ejemplo corrigiendo errores gramaticales, agregando ejemplos o ajustando estilos.
Al intentar participar, no encuentra una guía clara sobre cómo instalar y ejecutar el proyecto localmente, ni sobre la estructura de carpetas o el flujo de trabajo para realizar cambios. Esto genera incertidumbre y dificulta su contribución.
Con la incorporación de un archivo
CONTRIBUTING.md, el contribuidor podría:💡 Solución propuesta
Agregar un archivo CONTRIBUTING.md en la raíz del proyecto con:
Guía básica de instalación y ejecución
Descripción general de la estructura del proyecto
Indicaciones para editar Markdown y estilos
Opcionalmente, enlazarlo desde el README.md para mayor visibilidad.
Esta mejora se limita a documentación y no requiere cambios en la lógica del proyecto.
🚀 Impacto esperado
Este cambio beneficiará principalmente a nuevos contribuidores, facilitando su incorporación al proyecto.
Permitirá:
Reducir la barrera de entrada
Aumentar la participación, incluso de usuarios no técnicos
Mejorar la calidad del contenido (Markdown, redacción y estilos)
En conjunto, contribuirá a un crecimiento más activo y accesible del proyecto.
🔍 Alternativas consideradas
Se consideró incluir esta información únicamente en el README.md, pero esto podría sobrecargarlo y dificultar su lectura.
✅ Criterios de aceptación
🤝 ¿Te gustaría contribuir con esto?
Puedo ayudar a probarlo o revisarlo
📎 Recursos adicionales
No response