From 7800ecfd0eed5965cba04416b5254376837d73be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 13 Apr 2014 18:21:21 -0400 Subject: [PATCH 1/5] add step 4: review --- CONTRIBUTING.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index 331b4ed8..d820e033 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -54,6 +54,18 @@ For a more detailed discussion, read these :doc:`detailed documents ` on how to use Git with ``scikit-image`` (``_). +4. Review process: + + * Reviewers will write inline and/or general comments to improve the + implementation and the documentation. This step makes the quality of + scikit-image and ensures an homogeneous style as well as the best + performances. + + * Modify the code and commit locally. + + * Push your changes on GitHub as before. Your pull request will be + automatically updated. + .. note:: To reviewers: add a short explanation of what a branch did to the merge From de38fa242a4fb353ea6f220d0ae89f21046e8e83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sat, 19 Apr 2014 17:54:28 -0400 Subject: [PATCH 2/5] Stefan's comments --- CONTRIBUTING.txt | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index d820e033..ef2a2e30 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -56,15 +56,21 @@ For a more detailed discussion, read these :doc:`detailed documents 4. Review process: - * Reviewers will write inline and/or general comments to improve the - implementation and the documentation. This step makes the quality of - scikit-image and ensures an homogeneous style as well as the best - performances. + * Reviewers (the other developers and interested community members) will + write inline and/or general comments on your Pull Request (PR) to improve + the implementation and the documentation. Everyone has their code reviewed + in the same manner, it should not discourage you to contribute and it is + actually a chance to improve your coding skills. Code review ensures high + quality code, homogeneous style and optimal performance. - * Modify the code and commit locally. + * To update your pull request, make your changes on your local repository + and commit. As soon as those changes are pushed up to the same branch as + before, the pull request will be automatically updated. - * Push your changes on GitHub as before. Your pull request will be - automatically updated. + * `Travis-CI `__, a continuous integration service + is triggered after each Pull Request update, to build the code, run the + unittests, measure the code coverage and check the coding style (PEP8) of + your branch. .. note:: From 40f3813415aa3fda35e2a4a0d81373f9e856cd37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 20 Apr 2014 08:10:48 -0400 Subject: [PATCH 3/5] Add Juan's comments --- CONTRIBUTING.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index ef2a2e30..90d59fed 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -59,8 +59,8 @@ For a more detailed discussion, read these :doc:`detailed documents * Reviewers (the other developers and interested community members) will write inline and/or general comments on your Pull Request (PR) to improve the implementation and the documentation. Everyone has their code reviewed - in the same manner, it should not discourage you to contribute and it is - actually a chance to improve your coding skills. Code review ensures high + in the same manner. Don't let the review discourage you from contributing, + as it is a great chance to improve your coding. Code review ensures high quality code, homogeneous style and optimal performance. * To update your pull request, make your changes on your local repository @@ -70,7 +70,9 @@ For a more detailed discussion, read these :doc:`detailed documents * `Travis-CI `__, a continuous integration service is triggered after each Pull Request update, to build the code, run the unittests, measure the code coverage and check the coding style (PEP8) of - your branch. + your branch. The Travis tests must pass before your PR is merged. If + Travis fails, you can find out why by clicking on the "failed" icon to see + the build number, then on individual jobs to see the test logs. .. note:: From 16d6e569e591ad71ff3627f155dbc1cacc018e02 Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Sun, 20 Apr 2014 16:40:13 +0200 Subject: [PATCH 4/5] Make another pass through contributing guidelines --- CONTRIBUTING.txt | 48 ++++++++++++++++++++++++++++-------------------- 1 file changed, 28 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index 90d59fed..cc96e6d0 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -13,7 +13,7 @@ Here's the long and short of it: git clone git@github.com:your-username/scikit-image.git - * Add upstream repository:: + * Add the upstream repository:: git remote add upstream git@github.com:scikit-image/scikit-image.git @@ -43,8 +43,8 @@ Here's the long and short of it: git push origin transform-speedups - * Go to GitHub. The new branch will show up with a Pull Request button - - click it. + * Go to GitHub. The new branch will show up with a green Pull Request + button - click it. * If you want, post on the `mailing list `_ to explain your changes or @@ -57,28 +57,31 @@ For a more detailed discussion, read these :doc:`detailed documents 4. Review process: * Reviewers (the other developers and interested community members) will - write inline and/or general comments on your Pull Request (PR) to improve - the implementation and the documentation. Everyone has their code reviewed - in the same manner. Don't let the review discourage you from contributing, - as it is a great chance to improve your coding. Code review ensures high - quality code, homogeneous style and optimal performance. + write inline and/or general comments on your Pull Request (PR) to help + you improve its implementation, documentation and style. Every single + developer working on the project has their code reviewed, and we've come + to see it as friendly conversation from which we all learn and the + overall code quality benefits. Therefore, please don't let the review + discourage you from contributing: its only aim is to improve the quality + of project, not to criticize (we are, after all, very grateful for the + time you're donating!). * To update your pull request, make your changes on your local repository - and commit. As soon as those changes are pushed up to the same branch as - before, the pull request will be automatically updated. + and commit. As soon as those changes are pushed up (to the same branch as + before) the pull request will update automatically. - * `Travis-CI `__, a continuous integration service - is triggered after each Pull Request update, to build the code, run the - unittests, measure the code coverage and check the coding style (PEP8) of - your branch. The Travis tests must pass before your PR is merged. If - Travis fails, you can find out why by clicking on the "failed" icon to see - the build number, then on individual jobs to see the test logs. + * `Travis-CI `__, a continuous integration service, + is triggered after each Pull Request update to build the code, run unit + tests, measure code coverage and check coding style (PEP8) of your + branch. The Travis tests must pass before your PR can be merged. If + Travis fails, you can find out why by clicking on the "failed" icon (red + cross) and inspecting the build and test log. .. note:: - To reviewers: add a short explanation of what a branch did to the merge - message and, if closing a bug, also add "Closes gh-123" where 123 is the - bug number. + To reviewers: if it is not ovvious, add a short explanation of what a branch + did to the merge message and, if closing a bug, also add "Closes #123" + where 123 is the issue number. Divergence between ``upstream master`` and your feature branch @@ -118,7 +121,7 @@ Guidelines as NumPy and SciPy. * For new functionality, always add an example to the gallery. -* No changes should be committed without review. Ask on the +* No changes are ever committed without review. Ask on the `mailing list `_ if you get no response to your pull request. **Never merge your own pull request.** @@ -174,6 +177,7 @@ detailing the test coverage:: skimage/filter/__init__ 1 1 100% ... + Activate Travis-CI for your fork (optional) ------------------------------------------- @@ -194,6 +198,10 @@ It corresponds to steps one and two in Thus, as soon as you push your code to your fork, it will trigger Travis-CI, and you will receive an email notification when the process is done. +Every time Travis is triggered, it also calls on `Coveralls +`_ to inspect the current test overage. + + Bugs ---- From 715c074d4ed0a82f0e3582cf173f2c128622bc16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 20 Apr 2014 10:46:27 -0400 Subject: [PATCH 5/5] fix typo --- CONTRIBUTING.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index cc96e6d0..202210a1 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -79,7 +79,7 @@ For a more detailed discussion, read these :doc:`detailed documents .. note:: - To reviewers: if it is not ovvious, add a short explanation of what a branch + To reviewers: if it is not obvious, add a short explanation of what a branch did to the merge message and, if closing a bug, also add "Closes #123" where 123 is the issue number.