diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72d0a57..7d3afaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,89 @@ +# Contribuír a Reingenieria Educativa (ReEdu) + +Primero que nada, gracias por tomarte el tiempo para contribuír! + +Todo tipo de contribución es bienvenida y apreciada. + +> Y si te gusta el proyecto, pero no tienes el tiempo para contribuir, no hay ningún problema. Hay muchas otras formas en las que puedes apoyar al proyecto y mostrar tu aprecio, a nosotros nos encantaría que: +> +> * Le pongas una Estralla al proyecto. +> * Comentes acerca del proyecto en Social Media. +> * Menciones el proyecto a tus amigos y colegas. +> * Hagas referencias a nuestro proyecto en tus propios proyectos. + +## Tienes una pregunta? + +Antes de hacer una pregunta, por favor busca por un [Issues](https://github.com/reeduorg/reeduorg-docs/issues) existente que quizás pueda ayudarte. En caso encuentres un issue apropiado pero todavía necesites aclaración, puedes agregar un comentario o pregunta en ese issue. + +Si aún requires hacer una pregunta, te recomendamos: + +* Abrir un [Issue](https://github.com/reeduorg/reeduorg-docs/issues/new). +* Proveer todo el contexto e información que puedas acerca del issue o pregunta que tengas. + +Nosotros atenderemos el issue lo más pronto posible. + +## Cómo reportar un Bug + +Bugs y errores se manejan como issues. + +* Abrir un [Issue](https://github.com/reeduorg/reeduorg-docs/issues/new). +* Un buen reporte debe ser capaz de describir el Bug/error y permitir que otros puedan reproducirlo en sus propios sistemas, por tanto por favor provee detalles acerca de: + * El específico OS, plataforma y versión que estás usando. + * Los pasos para reproducir el issue. + * El comportamiento que tu esperabas. + * El comportamiento problemático que tú observas. + * Incluye ejemplos, pantallazos, logs y cualquier otro elemento que tú pienses pueda ser útil. + +Nosotros atenderemos tu reporte lo más pronto posible. + +> Por favor notar que nunca debes reportar un problema de seguridad, vulnerabilidad o bugs conteniendo información sensible a través del issue tracker o en ningún otro lugar público. Bugs sensibles deben ser enviados vía email encriptado a usando la siguiente PGP key: [0x70c7d0901133471df2e6e9a8006c13a68e25d3b7](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x70c7d0901133471df2e6e9a8006c13a68e25d3b7) + +## Sugerencias de Mejora + +Las sugerencias, mejoras y expansiones son discutidas y manejadas como issues. + +* Asegúrate que estés usando la última versión. +* Busca y lee cuidadosamente discusiones existentes acerca de sugerencias similares en el [Issues](https://github.com/reeduorg/reeduorg-docs/issues). Considera adicionar tus comentarios o sugerencias en algún issue ya existente. +* Si consideras que tu sugerencia estaría mejor representada como una nueva entrada: + * Abre un [Issue](https://github.com/reeduorg/reeduorg-docs/issues/new). + * Usa un **título claro y descriptivo** en el issue para identificar tu sugerencia. + * Provee una **descripción paso-a-paso de la mejora que estás sugiriendo** con el mayor detalle posible. + * **Describe el comportamiento actual** y **explica el comportamiento diferente que tú esperarías** y por qué. En este punto tú también puedes decir que alternativas no funcionrían para ti. + * Puedes también **incluir pantallazos y GIFs animados** que puedan ayudar a demostrar los pasos o hacer notar las partes que están relacionadas a tu sugerencia. + * **Explica por qué esta mejora sería útil** para muchos usuarios del proyecto. Aquí también puedes hacer referencia a otros proyectos que lo han resuelto mejor y podrían servir de inspiración. + +Nosotros consideraremos tu sugerencia tan pronto como sea posible. + +## Quieres contribuir contenido? + +> ### Nota Legal +> +> Para contribuír contenido a este proyecto, tú debes garantizar que tú eres el autor del 100% del contenido, que tienes los derechos necesarios del contenido, y que el contenido que estás contribuyendo puede ser proveído bajo la licencia del proyecto. + +Para coantribuír contenido a este proyecto: + +* Clone or fork the repo, and make your suggested contributions. +* Clona o haz un fork del repo, y haz tus contribuciones sugeridas. +* Publica tus contribuciones en un servidor de Git de acceso público. +* Envía un git-request-pull a [info@reedu.org](mailto:info@reedu.org) para su consideración. + +Nosotros consideraremos tu git-request-pull lo antes posible. + +## Credenciales + +Para poder contribuir a este proyecto en cualquiera de las formas descritas arriba, necesitarás credenciales en el servidor donde se mantiene este repositorio. + +Puedes contactar al administrador de este servidor para solicitar que se cree una cuenta para ti. + +-------------------------------------------------------------------------------- + # Contributing to Reingenieria Educativa (ReEdu) First of all, thanks a lot for taking the time to contribute! -All types of contribuions are encouraged and appreciated. +All types of contributions are encouraged and appreciated. -> And if you like the project, but just don't have time to contribute, that's pefectly fine. There are many other ways to support the project and show your appreciation, which we would be very happy about: +> And if you like the project, but just don't have time to contribute, that's perfectly fine. There are many other ways to support the project and show your appreciation, which we would be very happy about: > > * Star the project. > * Shout out about it in social media. @@ -36,7 +115,7 @@ Bugs and errors are tracked as issues. We will take care of your report as soon as possible. -> Please note that you must never report security related issues, vulnerabilities or bugs including sensitive informetion through the issue tracker, or elsewhere in public. Sensitive bugs must be sent by encrypted email to using the following PGP key: [0x70c7d0901133471df2e6e9a8006c13a68e25d3b7](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x70c7d0901133471df2e6e9a8006c13a68e25d3b7) +> Please note that you must never report security related issues, vulnerabilities or bugs including sensitive information through the issue tracker, or elsewhere in public. Sensitive bugs must be sent by encrypted email to using the following PGP key: [0x70c7d0901133471df2e6e9a8006c13a68e25d3b7](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x70c7d0901133471df2e6e9a8006c13a68e25d3b7) ## Suggesting Enhancements @@ -48,7 +127,7 @@ Suggestions and enhancements are discussed and managed as issues. * Open an [Issue](https://github.com/reeduorg/reeduorg-docs/issues/new). * Use a **clear and descriptive title** for the issue to identify the suggestion. * Provide a **step-by-step description of the suggested enhancement** in as many details as possible. - * **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. + * **Describe the current behavior** and **explain which behavior you'd expect to see instead** and why. At this point you can also tell which alternatives would not work for you. * You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. * **Explain why this enhancement would be useful** to most users of the project. You may also want to point out the other projects that solved it better and which could serve as inspiration.