Guías de proyectos

Plantilla CONTRIBUTING.md para un repositorio de código abierto

Un archivo CONTRIBUTING.md ayuda a pasar de «quiero ayudar» a una incidencia o solicitud de cambios útil. Explica la contribución más pequeña admitida y cómo verificarla. Los requisitos deben reflejar cómo funciona realmente tu proyecto, no un proceso ambicioso que nadie sigue.

Equipo editorial de GitHubStart · Actualizado

Copia y adapta la plantilla de contribución

Sustituye los marcadores y verifica cada comando y enlace. Sigue acogiendo correcciones de documentación e informes de errores aunque el colaborador aún no esté preparado para modificar el código de la aplicación.

# Contribuir

## Antes de empezar
Lee el README y revisa las incidencias existentes.
Para cambios grandes, comenta el enfoque antes de implementarlo.

## Configuración local
[Entorno de ejecución necesario y comandos de configuración verificados]

## Informar de un error
Incluye versión, entorno, pasos, resultado esperado y resultado real.
Elimina secretos y datos personales de los registros.

## Enviar una solicitud de cambios
- Explica el problema y el cambio propuesto.
- Mantén el cambio centrado.
- Ejecuta [las comprobaciones específicas del proyecto].
- Actualiza la documentación afectada.

## Revisión
[Quién revisa, cómo responder y disponibilidad realista]

## Otras formas de ayudar
[Documentación, ejemplos, traducciones o informes reproducibles]

Haz que las pautas sean fáciles de encontrar

GitHub reconoce las pautas de contribución en la raíz del repositorio y en los directorios docs o .github. Enlaza también el archivo desde el README, para que quien lea la introducción del proyecto encuentre el proceso de inmediato.

Revisa el recorrido desde los puntos reales de entrada a las contribuciones del repositorio. Si existen varios archivos de pautas, unifica las instrucciones contradictorias. Un colaborador no debería recibir un comando de configuración en el README y otro distinto e incompatible en la guía de contribución.

Diseña una primera contribución accesible

Elige una tarea pequeña con un resultado claro, como corregir un ejemplo para un entorno de ejecución compatible. Explica cómo reproducir el problema, qué comportamiento debe cambiar y cómo comprobar que se ha terminado. Evita etiquetar una tarea como apta para principiantes si depende de conocimientos internos sin documentar.

Indica con honestidad tu disponibilidad para revisar. Si no puedes prometer un plazo de respuesta, explica cómo consultar el estado. Unos límites claros reducen el trabajo abandonado y son más útiles que prometer integrar todas las contribuciones.

Preguntas frecuentes

¿CONTRIBUTING.md sustituye a README.md?

No. El README explica el proyecto y cómo usarlo. Las pautas de contribución explican cómo proponer y verificar cambios.

¿Debería copiar los comandos de pruebas de otro proyecto?

Solo si también son los comandos correctos para tu proyecto. Sustituye los marcadores por comandos que hayas comprobado realmente.

¿Las pautas de contribución garantizan más colaboradores?

No. Reducen la incertidumbre de las personas interesadas, pero siguen importando la utilidad del proyecto, la calidad de las tareas y el seguimiento de quienes lo mantienen.

Referencias