Merge pull request #3823 from consul/contributing
Update contributing guidelines
This commit is contained in:
Javier Martín
@@ -1,63 +1,57 @@
|
||||
# How to Contribute to this Project
|
||||
|
||||
## Core team members
|
||||
|
||||
* [Alberto García](https://github.com/decabeza)
|
||||
* [Javi Martín](https://github.com/javierm)
|
||||
* [Julián Herrero](https://github.com/microweb10)
|
||||
* [Raimond García](https://github.com/voodoorai2000)
|
||||
|
||||
## All other contributors
|
||||
|
||||
In addition to the formal team, there are [over a hundred contributors](https://github.com/consul/consul/graphs/contributors). Thank you so much for your code! Big thanks too to the people that contribute in many other ways including documentation, translations, evangelism, dev ops, communication, organizing and more!
|
||||
|
||||
Finally a special thanks to the former core team members. Lovingly known as The Alumni:
|
||||
|
||||
[Juanjo Bazán](https://github.com/xuanxu), [Enrique García Cota](https://github.com/kikito), [Alberto Calderón](https://github.com/bertocq), [María Checa](https://github.com/mariacheca)
|
||||
|
||||
## Code of conduct
|
||||
|
||||
The core team members and the project's community adopts an inclusive Code of Conduct that you can read in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
|
||||
The core team members and the project's community adopt an inclusive Code of Conduct that you can read in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
|
||||
|
||||
## Report an issue
|
||||
## Reporting an issue
|
||||
|
||||
The prefered way to report any bug is [opening an issue in the project's Github repo](https://github.com/consul/consul/issues/new).
|
||||
|
||||
For more informal communication, contact team members via twitter
|
||||
|
||||
## Resolve an issue
|
||||
|
||||
Admins tag issues using two label related with collaboration availability:
|
||||
|
||||
* `PRs-welcome`: [issues labeled with PRs-welcome](https://github.com/consul/consul/labels/PRs-welcome) are well defined features ready to be implemented by whoever wants to do it.
|
||||
|
||||
* `Not-ready`: with this label admins mark features or changes that are not well defined yet or subject to an internal decision. Is not a good idea to start implementation of these issues.
|
||||
|
||||
If you want to contribute code to solve an issue:
|
||||
|
||||
* Add a comment to tell everyone you are working on the issue.
|
||||
* If an issue has someone assigned it means that person is already working on it.
|
||||
* Fork the project.
|
||||
* Create a topic branch based on master.
|
||||
* Commit there your code to solve the issue.
|
||||
* Make sure all test are passing (and add specs to test any new feature you've added).
|
||||
* Follow these [best practices](https://github.com/styleguide/ruby)
|
||||
* Open a *pull request* to the main repository describing what issue you are addressing.
|
||||
|
||||
**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 without coding
|
||||
|
||||
* If you think there's a feature missing, or find a bug, create an issue (make sure it has not already been reported).
|
||||
* You can also help promoting the project talking about it in your social networks.
|
||||
|
||||
## How to report an issue
|
||||
The prefered way to report any bug is [opening an issue in the project's repo](https://github.com/consul/consul/issues/new).
|
||||
|
||||
* Try to use a descriptive and to-the-point title
|
||||
* Is a good idea to include some of there sections:
|
||||
* It's a good idea to include some of these sections:
|
||||
* Steps to reproduce the bug
|
||||
* Expected behaviour/response
|
||||
* Actual response
|
||||
* Sometimes it is also helpful if you mention your operating system, browser version and installed plugins.
|
||||
|
||||
Thanks! :heart: :heart: :heart:
|
||||
|
||||
## Solving an issue
|
||||
|
||||
[Issues labeled with help wanted](https://github.com/consul/consul/labels/help%20wanted) are well defined features ready to be implemented by whoever wants to do it.
|
||||
|
||||
If you want to contribute code to solve an issue:
|
||||
|
||||
* Add a comment to tell everyone you are working on the issue.
|
||||
* Open a *pull request* to the main repository describing what issue you are addressing and following our [coding conventions](#coding-conventions)
|
||||
|
||||
**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)
|
||||
|
||||
## Coding conventions
|
||||
|
||||
If you'd like us to review your pull request in good spirits, please follow our coding conventions:
|
||||
|
||||
* Include specs to test any changes you've made
|
||||
* Travis CI will check whether the rest of the application is still working properly; check its build and make sure all tests are passing
|
||||
* Your pull request will be automatically reviewed by Hound CI; fix any issues it reports
|
||||
* Follow [the seven rules of a great commit message](https://chris.beams.io/posts/git-commit/)
|
||||
|
||||
When we review your pull request and ask for changes, if you're proficient using `git rebase` edit existing commits instead of adding new ones. If you aren't proficient with `git rebase`, ignore this point.
|
||||
|
||||
## Contributors
|
||||
|
||||
### Core team members
|
||||
|
||||
* [Alberto García](https://github.com/decabeza)
|
||||
* [Javi Martín](https://github.com/javierm)
|
||||
* [Julián Herrero](https://github.com/microweb10)
|
||||
* [Raimond García](https://github.com/voodoorai2000)
|
||||
|
||||
### All other contributors
|
||||
|
||||
In addition to the formal team, there are [over a hundred contributors](https://github.com/consul/consul/graphs/contributors). Thank you so much for your code! Big thanks too to the people that contribute in many other ways including documentation, translations, evangelism, dev ops, communication, organizing and more!
|
||||
|
||||
Finally a special thanks to the former core team members. Lovingly known as The Alumni:
|
||||
|
||||
[Juanjo Bazán](https://github.com/xuanxu), [Enrique García Cota](https://github.com/kikito), [Alberto Calderón](https://github.com/bertocq), [María Checa](https://github.com/mariacheca)
|
||||
|
||||
@@ -1,68 +1,12 @@
|
||||
# Cómo Contribuir a este Proyecto
|
||||
|
||||
## Miembros del equipo core
|
||||
|
||||
* [Alberto García](https://github.com/decabeza)
|
||||
* [Javi Martín](https://github.com/javierm)
|
||||
* [Julián Herrero](https://github.com/microweb10)
|
||||
* [Raimond García](https://github.com/voodoorai2000)
|
||||
|
||||
## Todos los demás contribuidores
|
||||
|
||||
Además del equipo formal, hay [más de cien contribuidores](https://github.com/consul/consul/graphs/contributors). ¡Muchas gracias por vuestro código! También estamos muy agradecidos a las personas que contribuyen de otras formas, incluida la documentación, traducciones, evangelismo, administración de sistemas, comunicación, organización y más.
|
||||
|
||||
Finalmente, un agradecimiento especial a los antiguos miembros del equipo core. Conocidos con cariño como El Alumni:
|
||||
|
||||
[Juanjo Bazán](https://github.com/xuanxu), [Enrique García Cota](https://github.com/kikito), [Alberto Calderón](https://github.com/bertocq), [María Checa](https://github.com/mariacheca)
|
||||
|
||||
## Código de conducta
|
||||
|
||||
Los miembros del proyecto y la comunidad de personas que contribuyen a él se adhieren a un código de conducta que se puede consultar en el archivo [CODE_OF_CONDUCT_ES.md](CODE_OF_CONDUCT_ES.md).
|
||||
|
||||
## Comunicación general y de incidencias
|
||||
|
||||
El método preferido para informar sobre una incidencia en el proyecto es [creando una incidencia en la cuenta de Github del proyecto](https://github.com/consul/consul/issues/new).
|
||||
|
||||
Para comunicación más puntual e informal, contacta con los miembros del equipo por twitter.
|
||||
|
||||
## Resolver una incidencia
|
||||
|
||||
Los administradores utilizan dos etiquetas relacionadas con la disponibilidad para aceptar colaboraciones con las que marcar incidencias:
|
||||
|
||||
* `PRs-welcome`: las [incidencias marcadas como PRs-welcome](https://github.com/consul/consul/labels/PRs-welcome) son funcionalidades bien definidas y que están listas para que quien quiera pueda implementarlas.
|
||||
|
||||
* `Not-ready`: con esta etiqueta se señalan funcionalidades o cambios que han de realizarse pero que todavía no están del todo definidos o falta alguna decisión a nivel interno que tomar. Por tanto se desaconseja que se inicie su implementación de momento.
|
||||
|
||||
Cuando quieras resolver una incidencia mediante código:
|
||||
|
||||
* Avisa de que vas a trabajar en esta incidencia añadiendo un comentario.
|
||||
* Cuando las incidencias tienen a alguien asignado significa que esa persona ya está trabajando en esa issue.
|
||||
* Haz un fork del proyecto
|
||||
* Crea una rama para resolver la incidencia desde la rama `master`
|
||||
* Añade el código necesario para resolver la incidencia en tantos commits como sea preciso
|
||||
* Asegúrate de que los tests pasan (y escribe más tests para probar la nueva funcionalidad si fuera preciso)
|
||||
* Sigue estas [buenas prácticas](https://github.com/styleguide/ruby)
|
||||
* Envía una *pull request* al repositorio principal indicando la incidencia que se está arreglando.
|
||||
|
||||
**¿Es tu primer Pull Request?** Puedes aprender en este curso gratuito (en inglés) sobre [cómo contribuir a un proyecto OpenSource en GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
|
||||
|
||||
|
||||
## Limpiar
|
||||
|
||||
En la urgencia del momento, las cosas a veces se ensucian, puedes ayudarnos a limpiar la casa:
|
||||
|
||||
* implementando [tests pendientes](https://travis-ci.org/consul/consul)
|
||||
* incrementando la [cobertura de tests](https://coveralls.io/github/consul/consul?branch=master)
|
||||
* mejorando la [calidad del código](https://codeclimate.com/github/consul/consul)
|
||||
* haciendo el [código consistente](https://github.com/bbatsov/rubocop)
|
||||
|
||||
## Otras formas de contribuir sin código
|
||||
|
||||
* Si crees que hay una funcionalidad que hace falta, o descubres un problema, abre una incidencia (asegúrate de que
|
||||
no haya una incidencia para lo mismo ya abierta antes)
|
||||
* También puedes ayudar dando este proyecto a conocer
|
||||
|
||||
## Cómo escribir una incidencia
|
||||
El método preferido para informar sobre una incidencia en el proyecto es [creando una incidencia en el repositorio del proyecto](https://github.com/consul/consul/issues/new).
|
||||
|
||||
* Trata de darle un título descriptivo (algo más que "xxx no funciona").
|
||||
* Es buena idea incluir las siguientes secciones:
|
||||
@@ -72,3 +16,42 @@ En la urgencia del momento, las cosas a veces se ensucian, puedes ayudarnos a li
|
||||
* También es buena idea que incluyas tu sistema operativo, navegador, versión de navegador y plugins instalados.
|
||||
|
||||
¡Gracias! :heart: :heart: :heart:
|
||||
|
||||
## Resolver una incidencia
|
||||
|
||||
Las [incidencias marcadas como help wanted](https://github.com/consul/consul/labels/help%20wanted) son funcionalidades bien definidas y que están listas para que quien quiera pueda implementarlas.
|
||||
|
||||
Cuando quieras resolver una incidencia mediante código:
|
||||
|
||||
* Avisa de que vas a trabajar en esta incidencia añadiendo un comentario.
|
||||
* Envía una *pull request* al repositorio principal indicando qué incidencia estás resolviendo y siguiendo nuestras [convenciones de código](#convenciones-de-código)
|
||||
|
||||
**¿Es tu primer Pull Request?** Puedes aprender en este curso gratuito (en inglés) sobre [cómo contribuir a un proyecto OpenSource en GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
|
||||
|
||||
## Convenciones de código
|
||||
|
||||
Si quieres que revisemos tu código con una sonrisa, por favor sigue nuestras convenciones:
|
||||
|
||||
* Incluye tests para los cambios que hayas hecho
|
||||
* Travis CI comprobará automáticamente que el resto de la aplicación sigue funcionando; asegúrate de que los tests pasan
|
||||
* Tus cambios serán revisados automáticamente por Hound CI; arregla los problemas de los que informa (si es que hay alguno)
|
||||
* Sigue [las siete reglas para un gran mensaje de commit](https://chris.beams.io/posts/git-commit/)
|
||||
|
||||
Cuando revisemos tu código y te pidamos que cambies alguna cosa, si tienes experiencia con `git rebase` edita los commits existentes en vez de añadir más. Si no tienes experiencia con `git rebase`, puedes saltarte este punto.
|
||||
|
||||
## Contribuidores
|
||||
|
||||
## Miembros del equipo principal
|
||||
|
||||
* [Alberto García](https://github.com/decabeza)
|
||||
* [Javi Martín](https://github.com/javierm)
|
||||
* [Julián Herrero](https://github.com/microweb10)
|
||||
* [Raimond García](https://github.com/voodoorai2000)
|
||||
|
||||
## Todos los demás contribuidores
|
||||
|
||||
Además del equipo principal, hay [más de cien contribuidores](https://github.com/consul/consul/graphs/contributors). ¡Muchas gracias por vuestro código! También estamos muy agradecidos a las personas que contribuyen de otras formas, incluida la documentación, traducciones, evangelismo, administración de sistemas, comunicación, organización y más.
|
||||
|
||||
Finalmente, un agradecimiento especial a los antiguos miembros del equipo principal. Conocidos con cariño como El Alumni:
|
||||
|
||||
[Juanjo Bazán](https://github.com/xuanxu), [Enrique García Cota](https://github.com/kikito), [Alberto Calderón](https://github.com/bertocq), [María Checa](https://github.com/mariacheca)
|
||||
|
||||
@@ -21,7 +21,7 @@ Citizen Participation and Open Government Application
|
||||
[](https://rocketvalidator.com/opensource)
|
||||
|
||||
[](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted")
|
||||
[](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted")
|
||||
|
||||
[](https://knapsackpro.com/dashboard/organizations/176/projects/202/test_suites/318/builds?utm_campaign=organization-id-176&utm_content=test-suite-id-318&utm_medium=readme&utm_source=knapsack-pro-badge&utm_term=project-id-202)
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ Aplicación de Participación Ciudadana y Gobierno Abierto
|
||||
[](https://rocketvalidator.com/opensource)
|
||||
|
||||
[](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3APRs-welcome)
|
||||
[](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted")
|
||||
|
||||
Este es el repositorio de código abierto de la Aplicación de Participación Ciudadana CONSUL, creada originariamente por el Ayuntamiento de Madrid.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user