Update CONTRIBUTING and README with latest links and suggestions
This commit is contained in:
Lucía Luzuriaga
@@ -26,7 +26,7 @@ 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)
|
||||
**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/courses/how-to-contribute-to-an-open-source-project-on-github)
|
||||
|
||||
## Coding conventions
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ 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)
|
||||
**¿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/courses/how-to-contribute-to-an-open-source-project-on-github)
|
||||
|
||||
## Convenciones de código
|
||||
|
||||
|
||||
@@ -14,7 +14,6 @@ Citizen Participation and Open Government Application
|
||||
[](https://www.w3.org/WAI/eval/Overview)
|
||||
|
||||
|
||||
[](https://codeclimate.com/github/consuldemocracy/consuldemocracy)
|
||||
[](https://coveralls.io/github/consuldemocracy/consuldemocracy?branch=master)
|
||||
[](https://translate.consuldemocracy.org/)
|
||||
[](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)
|
||||
|
||||
@@ -14,7 +14,6 @@ Aplicación de Participación Ciudadana y Gobierno Abierto
|
||||
[](https://www.w3.org/WAI/eval/Overview)
|
||||
|
||||
|
||||
[](https://codeclimate.com/github/consuldemocracy/consuldemocracy)
|
||||
[](https://coveralls.io/github/consuldemocracy/consuldemocracy?branch=master)
|
||||
[](https://translate.consuldemocracy.org/)
|
||||
|
||||
|
||||
@@ -25,11 +25,12 @@ We suggest to follow these steps to keep a good track of the changes you're abou
|
||||
- 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`).
|
||||
- Check our [coding conventions](coding_conventions.md) to help you decide how to write your code.
|
||||
- Work in your branch committing there your changes.
|
||||
- If possible, we prefer small PRs.
|
||||
- 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 Democracy repository](https://github.com/consuldemocracy/consuldemocracy/) 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).
|
||||
> **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/courses/how-to-contribute-to-an-open-source-project-on-github).
|
||||
|
||||
## Other ways of contributing
|
||||
|
||||
|
||||
@@ -25,11 +25,12 @@ Te sugerimos seguir los siguientes pasos para facilitar el seguimiento de los ca
|
||||
- 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`).
|
||||
- Comprueba nuestras [convenciones de código](coding_conventions.md) para ayudarte a decidir cómo escribir tu código.
|
||||
- Desarrolla los cambios haciendo commits en tu nueva rama.
|
||||
- De ser posible, preferimos PRs pequeños.
|
||||
- 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 Democracy](https://github.com/consuldemocracy/consuldemocracy/) 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 Democracy 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).
|
||||
> **¿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/courses/how-to-contribute-to-an-open-source-project-on-github) (en inglés).
|
||||
|
||||
## Otras formas de contribuir
|
||||
|
||||
|
||||
Reference in New Issue
Block a user