diff --git a/docs/en/open_source/contributing.md b/docs/en/open_source/contributing.md index 854139a31..066c10cdd 100644 --- a/docs/en/open_source/contributing.md +++ b/docs/en/open_source/contributing.md @@ -1 +1,34 @@ # Contributing + +We appreciate you want to help us by contributing to Consul. Here's a guide we made describing how to contribute changes to the project. + +## Reporting an issue + +If you have seen anything wrong in the platform performance or directly in the code, we encourage you to [open an issue in the Consul Github repository](https://github.com/consul/consul/issues/new). + +Before doing it, **please take some time to check the [existing issues](https://github.com/consul/consul/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before, if you have more details about it you can write a comment in the issue page -a little more help can make a huge difference! + +In order to write a new issue, take into account these few tips to make it easy to read and comprehend: +- Try to use a descriptive and to-the-point title. +- It's a good idea to include some sections -in case they're needed- such as: steps to reproduce the bug, expected behaviour/response, actual response or screenshots. +- Also it could be helpful to provide your operating system, browser version and installed plugins. + +## Resolving an issue + +[Issues in Consul](https://github.com/consul/consul/issues) labeled with `PRs-welcome` are well defined features ready to be implemented by whoever wants to do it. In the other hand, the `not-ready` label marks features or changes not well defined yet or subject to an internal decision, so we recommend not to try to resolve them until the admins come to a resolution. + +We suggest to follow these steps to keep a good track of the changes you're about to make: + +- First of all, add a comment to the issue to make everyone know you are going to work on it. If the issue has someone assigned it means that person is already solving it. +- Fork the project. +- Create a feature branch based on the `master` branch. To make it easier to identify, you can name it with the issue number followed by a concise and descriptive name (e.g. `123-fix_proposals_link`). +- Work in your branch committing there your changes. +- Make sure all tests are passing. In case you're extending or creating a new feature, consider adding its own specs. +- Once you've finished, send a **pull request** to the [Consul repository](https://github.com/consul/consul/) describing your solution to help us understand it. It's also important to tell what issue you're addressing, so specify it in the pull request description's first line (e.g. `Fixes #123`). +- Our core team will review your PR and suggest changes if necessary. If everything looks good, your changes will be merged :) + +> **Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). + +## Other ways of contributing + +We'll appreciate any kind of contribution to Consul. Even if you can't contribute to it coding, you still can create issues to notify the project owners with as much information as you can provide about anything wrong you see, and someone will take care of it as soon as possible. diff --git a/docs/es/open_source/contributing.md b/docs/es/open_source/contributing.md index ee33f5050..9827bd47b 100644 --- a/docs/es/open_source/contributing.md +++ b/docs/es/open_source/contributing.md @@ -1 +1,33 @@ # Contribuciones + +Te agradecemos que quieras colaborar contribuyendo a Consul. Aquí tienes una guía donde consultar cómo sugerir cambios y mejoras al proyecto. + +## Reportar un issue + +Si has visto algún error en la plataforma o directamente en el código, te animamos a [abrir un issue en el repositorio en Github de Consul](https://github.com/consul/consul/issues/new). + +Antes de hacerlo, **por favor tómate un tiempo para comprobar los [issues ya existentes](https://github.com/consul/consul/issues) y asegúrate de que lo que estás a punto de reportar no ha sido reportado previamente** por otra persona. De ser así, si tienes más detalles acerca de la incidencia puedes escribir un comentario en la página del issue ‑¡un poco de ayuda puede marcar una gran diferencia! + +Para escribir un nuevo issue, ten en cuenta estas recomendaciones para hacerlo más fácil de leer y comprender: +- Intenta usar un título descriptivo. +- Es buena idea incluir algunas secciones -en caso de que sean necesarias- como los pasos para reproducir el error, el comportamiento o respuesta que cabría esperar, la respuesta que devuelve o capturas de pantalla. +- También puede ser de ayuda incluir en la descripción tu sistema operativo, versión del navegador que usaste y posibles plugins instalados. + +## Resolver un issue + +[Los issues en Consul](https://github.com/consul/consul/issues) con la etiqueta `PRs-welcome` son funcionalidades bien definidas que están listas para ser implementadas por cualquiera que se ofrezca a ello. Por otra parte, la etiqueta `not-ready` indica las funcionalidades o cambios que aún están pendientes de concretar, por lo que recomendamos no intentar resolverlos hasta que los/as administradores/as lleguen a una resolución. + +Te sugerimos seguir los siguientes pasos para facilitar el seguimiento de los cambios que vayas a hacer: +- Primero, añade un comentario en el issue para notificar que vas resolverlo. Si el issue tiene a alguien asignado significa que ya hay alguien encargado de él. +- Crea un fork del proyecto. +- Crea una rama de funcionalidad basada en la rama `master`. Para identificarla más fácilmente, puedes nombrarla con el número del issue seguido de un nombre conciso y descriptivo (por ejemplo: `123-fix_proposals_link`). +- Desarrolla los cambios haciendo commits en tu nueva rama. +- Asegúrate de que todos los tests pasan. Si estás extendiendo una funcionalidad o creando una nueva, considera añadir sus propios tests. +- Cuando hayas terminado, envía un **pull request** al [repositorio de Consul](https://github.com/consul/consul/) describiendo la solución que propones para ayudarnos a entenderlo. También es importante que especifiques qué issue estás resolviendo al principio de la descripción del PR (por ejemplo, `Fixes #123`). +- El equipo de Consul revisará tu PR y podrá sugerir cambios si son necesarios. Una vez esté todo bien, tus cambios serán introducidos en el proyecto :) + +> **¿Es tu primer Pull Request?** Puedes aprender cómo contribuir a un proyecto en Github siguiendo los tutoriales [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) (en inglés). + +## Otras formas de contribuir + +Agradecemos cualquier tipo de contribución a Consul. Incluso si no puedes contribuir al código del proyecto, puedes crear issues acerca de cualquier problema o error que hayas encontrado, y alguien se encargará de resolverlo a la mayor brevedad posible.