From 470ee07e77e8626c94056c9bdfadb37fe9c6e40c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javi=20Mart=C3=ADn?= Date: Wed, 6 Nov 2019 17:09:59 +0100 Subject: [PATCH] Add information about coding conventions We split the section about pull requests, reducing the steps needed to contribute since there's already a link to help people working on their first pull request, and the rest don't need to be told to fork the repo. --- CONTRIBUTING.md | 18 ++++++++++++------ CONTRIBUTING_ES.md | 18 ++++++++++++------ 2 files changed, 24 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a56a27a24..dcb324ef6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,15 +15,21 @@ The prefered way to report any bug is [opening an issue in the project's repo](h If you want to contribute code to solve an issue: * Add a comment to tell everyone you are working on the issue. -* 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. +* 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. + ## 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). diff --git a/CONTRIBUTING_ES.md b/CONTRIBUTING_ES.md index 6a409d6c7..5e196aaae 100644 --- a/CONTRIBUTING_ES.md +++ b/CONTRIBUTING_ES.md @@ -15,15 +15,21 @@ Las [incidencias marcadas como help wanted](https://github.com/consul/consul/lab Cuando quieras resolver una incidencia mediante código: * Avisa de que vas a trabajar en esta incidencia añadiendo un comentario. -* 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. +* 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. + ## 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