From ed8153ff8b89eca790e7969f9c2ac6bcf4724f9d Mon Sep 17 00:00:00 2001 From: Riccardo Magliocchetti Date: Mon, 5 Jun 2017 03:00:33 +0200 Subject: [PATCH] update contributing a bit re contributing code (#2903) * CONTRIBUTING: document starter_task label * CONTRIBUTING: PR should work travis python versions * CONTRIBUTING: move PR guidelines at the top * CONTRIBUTING: no need to open a new pr after review --- CONTRIBUTING.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c681f461..645f926ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ open to whoever wants to implement it. ### Implement Features Look through the GitHub issues for features. Anything tagged with -"feature" is open to whoever wants to implement it. +"feature" or "starter_task" is open to whoever wants to implement it. ### Documentation @@ -47,6 +47,24 @@ If you are proposing a feature: - Remember that this is a volunteer-driven project, and that contributions are welcome :) +## Pull Request Guidelines + +Before you submit a pull request from your forked repo, check that it +meets these guidelines: + +1. The pull request should include tests, either as doctests, + unit tests, or both. +2. If the pull request adds functionality, the docs should be updated + as part of the same PR. Doc string are often sufficient, make + sure to follow the sphinx compatible standards. +3. The pull request should work for Python 2.7, and ideally python 3.4+. + ``from __future__ import`` will be required in every `.py` file soon. +4. Code will be reviewed by re running the unittests, flake8 and syntax + should be as rigorous as the core Python project. +5. Please rebase and resolve all conflicts before submitting. +6. If you are asked to update your pull request with some changes there's + no need to create a new one. Push your changes to the same branch. + ## Documentation The latest documentation and tutorial are available [here](http://airbnb.io/superset). @@ -292,23 +310,6 @@ The `variables.less` and `bootswatch.less` files that ship with Superset are der [Bootswatch](https://bootswatch.com) and thus extend Bootstrap. Modify variables in these files directly, or swap them out entirely with the equivalent files from other Bootswatch (themes)[https://github.com/thomaspark/bootswatch.git] -## Pull Request Guidelines - -Before you submit a pull request from your forked repo, check that it -meets these guidelines: - -1. The pull request should include tests, either as doctests, - unit tests, or both. -2. If the pull request adds functionality, the docs should be updated - as part of the same PR. Doc string are often sufficient, make - sure to follow the sphinx compatible standards. -3. The pull request should work for Python 2.6, 2.7, and ideally python 3.3. - ``from __future__ import`` will be required in every `.py` file soon. -4. Code will be reviewed by re running the unittests, flake8 and syntax - should be as rigorous as the core Python project. -5. Please rebase and resolve all conflicts before submitting. - - ## Translations We use [Babel](http://babel.pocoo.org/en/latest/) to translate Superset. The