Agrega una cálida bienvenida y anima a todos a participar
Muchas gracias por tu interes en participar en [Proyecto] 🎉!
Escribe la visión de tu proyecto. La redundancia es tu amiga
[Proyecto] es ...
Agregua información sobre por qué las personas deben leer la guía de participación y * qué * es.
Este documento es un conjunto de guias para contribuir en el [Proyecto] en GitHub. Estas son guías, no reglas. Esta guía está destinada a facilitar tu participación.
Si tu guía es muy larga, considera agregar un índice.
- Guías de participación
- En qué estamos trabajando
- Cómo enviar cambios
- Cómo reportar bugs
- Canales de comunicación
Este proyecto se adhiere al siguiente código de conducta. AL participar en este proyecto se espera que lo mantengas. Por favor reporta cualquier conducta inadecuada a [EMAIL]
Este es un buen lugar para vincular tu Roadmap, GitHub Milestones o Proyectos para que los recién llegados puedan ver en qué estás trabajando.
Echa un vistazo a los issues en nuestra versión actual o busca algunos buenos bugs para comenzar!
Revisa este ejercicio de planeación para comenzar a crear tus propias metas e issues. Esto ayudará a los recién llegados a saber dónde pueden ayudar.
Explica cómo deseas que los contribuidores propongan cambios. Para un flujo de ejemplo de trabajo en GitHub, consulta las instrucciones para contribuciones de código de Node.js
Una vez que has identificado alguno de los issues en el que puedes ayudar, ¡Estás listo para realizar un cambio en el repositorio del proyecto!
- Fork este repositorio. Esto crea tu propia versión de este proyecto puedes editarla y usarla.
- Haz tus cambios! Puedes hacerlo en la interfaz de GitHub en tu máquina. Una vez que estés satisfecho con tus cambios ...
- Realiza un pull request. Esto inicia una discusión sobre tu proyecto y le permite al líder del proyecto saber qué cambios estas proponiendo.
¿Es la primera vez que contribuyes al código abierto? Mira esta serie gratis Cómo contribuir a un proyecto de código abierto en GitHub.
Pide a tus colaboradores que estén atentos a cualquier problema que pueda causar errores en el proyecto. Estos pueden ser problemas en el código (si estás creando software), omisiones de contenido o errores gramaticales (si está creando un recurso de aprendizaje) o cualquier problema con la funcionalidad o el diseño de su proyecto.
La mayoría de los proyectos invitan a todos los colaboradores a informar errores, por lo que la "depuración" o la solución de problemas ocurre rápidamente y con la ayuda de la comunidad. Echa un vistazo a ejemplo de Atom para saber cómo enseñar a las personas a reportar errores en tu proyecto.
¿Encontraste un error? Por favor presente cualquier bug, solicitud o pregunta en nuestro rastreador de problemas [LINK para reportar bugs]!
¿Tienes una sala de chat o una lista de correo electrónico que usas para discutir este proyecto? ¡Lista todos aquí! Proporciona información de contacto clara y describe el proceso para ponerse en contacto para cualquier persona con preguntas.