From ef977c903624cf69ded1b06997340fe5ae59200b Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Thu, 8 Dec 2016 18:04:13 -0500 Subject: [PATCH 1/9] [MRG] [doc skip] docs(contributorGuide): add commit message magic commands to avoid unnecessarily building docs in CI --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f6115e1c3a22..ec735d24ebf44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ likelihood of your contribution being merged.** How to contribute ----------------- -The preferred workflow for contributing to scikit-learn is to fork the +The preferred workflow for contributing to scikit-learn is to fork the [main repository](https://github.com/scikit-learn/scikit-learn) on GitHub, clone, and develop on a branch. Steps: @@ -26,13 +26,13 @@ GitHub, clone, and develop on a branch. Steps: $ git clone git@github.com:YourLogin/scikit-learn.git $ cd scikit-learn ``` - + 3. Create a ``feature`` branch to hold your development changes: ```bash $ git checkout -b my-feature ``` - + Always use a ``feature`` branch. It's good practice to never work on the ``master`` branch! 4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files: @@ -48,11 +48,13 @@ GitHub, clone, and develop on a branch. Steps: $ git push -u origin my-feature ``` + *Note*: if your PR includes changes to files under the ``doc/`` or ``examples/`` folders, include in your commit message ``[doc build]``. Otherwise, include in your commit message ``[doc skip]``. This will allow the CI to avoid unnecessarily building the docs. + 5. Go to the GitHub web page of your fork of the scikit-learn repo. Click the 'Pull request' button to send your changes to the project's maintainers for review. This will send an email to the committers. -(If any of the above seems like magic to you, please look up the +(If any of the above seems like magic to you, please look up the [Git documentation](https://git-scm.com/documentation) on the web, or ask a friend or another contributor for help.) Pull Request Checklist @@ -179,7 +181,7 @@ following rules before submitting: import scipy; print("SciPy", scipy.__version__) import sklearn; print("Scikit-Learn", sklearn.__version__) ``` - + - Please be specific about what estimators and/or functions are involved and the shape of the data, as appropriate; please include a [reproducible](http://stackoverflow.com/help/mcve) code snippet @@ -228,5 +230,5 @@ Further Information ------------------- Visit the [Contributing Code](http://scikit-learn.org/stable/developers/index.html#coding-guidelines) -section of the website for more information including conforming to the +section of the website for more information including conforming to the API spec and profiling contributed code. From 90e2e9ea53fbbbbd65fadf22131b517adb457726 Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Thu, 8 Dec 2016 23:17:09 -0500 Subject: [PATCH 2/9] chore(contributorGuide): move CI magic commands to location after documentation and minor formatting corrections --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec735d24ebf44..fd7e1a532b117 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,8 +48,6 @@ GitHub, clone, and develop on a branch. Steps: $ git push -u origin my-feature ``` - *Note*: if your PR includes changes to files under the ``doc/`` or ``examples/`` folders, include in your commit message ``[doc build]``. Otherwise, include in your commit message ``[doc skip]``. This will allow the CI to avoid unnecessarily building the docs. - 5. Go to the GitHub web page of your fork of the scikit-learn repo. Click the 'Pull request' button to send your changes to the project's maintainers for review. This will send an email to the committers. @@ -115,6 +113,11 @@ following rules before you submit a pull request: scale in dimensionality: n_features is expected to be lower than 100". +- If your PR includes changes to files under the ``doc/`` or + ``examples/`` folders, include ``[doc build]`` in your commit message. + Otherwise, include ``[doc skip]`` in your commit message. This will + allow the CI to avoid unnecessarily building the docs. + You can also check for common programming errors with the following tools: From c85572255a6b4e51b8a25da9947cfdaa9e705c23 Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Thu, 8 Dec 2016 23:33:02 -0500 Subject: [PATCH 3/9] [doc skip] chore(contributorGuide): minor formatting change on wording --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd7e1a532b117..c9384ace1173d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -115,7 +115,7 @@ following rules before you submit a pull request: - If your PR includes changes to files under the ``doc/`` or ``examples/`` folders, include ``[doc build]`` in your commit message. - Otherwise, include ``[doc skip]`` in your commit message. This will + Otherwise, include ``[doc skip]`` in your commit message which will allow the CI to avoid unnecessarily building the docs. You can also check for common programming errors with the following From 652f7f5aa371fce3c9ab4dc515394cc019e74bac Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Thu, 8 Dec 2016 23:36:39 -0500 Subject: [PATCH 4/9] [doc skip] chore(devContributing): echo changes in top level contributor guide to include CI magic commands for commit messages --- doc/developers/contributing.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 7c6c7e12a7956..ba116124b738f 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -215,6 +215,11 @@ rules before submitting a pull request: the example. For more details on writing and building the documentation, see the :ref:`contribute_documentation` section. + * If your PR includes changes to files under the ``doc/`` or + ``examples/`` folders, include ``[doc build]`` in your commit message. + Otherwise, include ``[doc skip]`` in your commit message which will + allow the CI to avoid unnecessarily building the docs. + You can also check for common programming errors with the following tools: * Code with a good unittest coverage (at least 90%, better 100%), check @@ -309,10 +314,10 @@ following rules before submitting: Issues for New Contributors --------------------------- -New contributors should look for the following tags when looking for issues. -We strongly recommend that new contributors tackle "easy" issues first: this -helps the contributor become familiar with the contribution workflow, and -for the core devs to become acquainted with the contributor; besides which, +New contributors should look for the following tags when looking for issues. +We strongly recommend that new contributors tackle "easy" issues first: this +helps the contributor become familiar with the contribution workflow, and +for the core devs to become acquainted with the contributor; besides which, we frequently underestimate how easy an issue is to solve! .. topic:: Easy Tags @@ -327,7 +332,7 @@ we frequently underestimate how easy an issue is to solve! .. topic:: Need Contributor Tags - We often use the Need Contributor tag to mark issues regardless of difficulty. Additionally, + We often use the Need Contributor tag to mark issues regardless of difficulty. Additionally, we use the Need Contributor tag to mark Pull Requests which have been abandoned by their original contributor and are available for someone to pick up where the original contributor left off. The list of issues with the Need Contributor tag can be found @@ -488,8 +493,8 @@ There are three other tags to help new contributors: but is still approachable for someone new to the project. :Needs Contributor: - This tag marks an issue which currently lacks a contributor or a - PR that needs another contributor to take over the work. These + This tag marks an issue which currently lacks a contributor or a + PR that needs another contributor to take over the work. These issues can range in difficulty, and may not be approachable for new contributors. Note that not all issues which need contributors will have this tag. From b2d7fb57961ca3ef701244391d4b94fff8159ad8 Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Sun, 11 Dec 2016 15:47:40 -0500 Subject: [PATCH 5/9] chore(readme): update to include formatting changes requested --- CONTRIBUTING.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9384ace1173d..018a57f6b4070 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,10 +113,20 @@ following rules before you submit a pull request: scale in dimensionality: n_features is expected to be lower than 100". -- If your PR includes changes to files under the ``doc/`` or - ``examples/`` folders, include ``[doc build]`` in your commit message. - Otherwise, include ``[doc skip]`` in your commit message which will - allow the CI to avoid unnecessarily building the docs. +A Note about CI: +---------------- +- Travis is used for testing on Linux platforms +- Appveyor is used for testing on Windows platforms +- CircleCI is used to build the docs for viewing + + Please note that if one of the following markers appear in the latest commit message, the following actions are taken. + +Commit Message Marker | Action Taken by CI +----------|--------------- +[ci skip] | CI is skipped completely +[doc skip] | Docs are not built +[doc quick] | Docs built, but exclude example gallery plots +[doc build] | Docs built, including example gallery plots You can also check for common programming errors with the following tools: From 87e77eadb42ffdddd92c4f2f33adce922ceaa1e4 Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Sun, 11 Dec 2016 15:48:48 -0500 Subject: [PATCH 6/9] chore(contributorRst): update to include formatting changes requested --- doc/developers/contributing.rst | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index ba116124b738f..9f002e909c5e2 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -215,10 +215,22 @@ rules before submitting a pull request: the example. For more details on writing and building the documentation, see the :ref:`contribute_documentation` section. - * If your PR includes changes to files under the ``doc/`` or - ``examples/`` folders, include ``[doc build]`` in your commit message. - Otherwise, include ``[doc skip]`` in your commit message which will - allow the CI to avoid unnecessarily building the docs. +A Note about CI: +---------------- + * Travis is used for testing on Linux platforms + * Appveyor is used for testing on Windows platforms + * CircleCI is used to build the docs for viewing + + Please note that if one of the following markers appear in the latest commit message, the following actions are taken. + + ====================== =================== + Commit Message Marker Action Taken by CI + ---------------------- ------------------- + [ci skip] CI is skipped completely + [doc skip] Docs are not built + [doc quick] Docs built, but excludes example gallery plots + [doc build] Docs built including example gallery plots + ====================== =================== You can also check for common programming errors with the following tools: From 6b50b8c2bd8666638fb89a98029bb496884ff34e Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Wed, 14 Dec 2016 21:35:36 -0800 Subject: [PATCH 7/9] chore(CI): move CI/commit message magics to end of notes in Pull Requests section --- doc/developers/contributing.rst | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 9f002e909c5e2..48dbd1147677b 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -215,23 +215,6 @@ rules before submitting a pull request: the example. For more details on writing and building the documentation, see the :ref:`contribute_documentation` section. -A Note about CI: ----------------- - * Travis is used for testing on Linux platforms - * Appveyor is used for testing on Windows platforms - * CircleCI is used to build the docs for viewing - - Please note that if one of the following markers appear in the latest commit message, the following actions are taken. - - ====================== =================== - Commit Message Marker Action Taken by CI - ---------------------- ------------------- - [ci skip] CI is skipped completely - [doc skip] Docs are not built - [doc quick] Docs built, but excludes example gallery plots - [doc build] Docs built including example gallery plots - ====================== =================== - You can also check for common programming errors with the following tools: * Code with a good unittest coverage (at least 90%, better 100%), check @@ -280,6 +263,22 @@ and Cython optimizations. `_ sections. +.. topic:: Continuous Integration (CI) + + * Travis is used for testing on Linux platforms + * Appveyor is used for testing on Windows platforms + * CircleCI is used to build the docs for viewing + + Please note that if one of the following markers appear in the latest commit message, the following actions are taken. + ====================== =================== + Commit Message Marker Action Taken by CI + ---------------------- ------------------- + [ci skip] CI is skipped completely + [doc skip] Docs are not built + [doc quick] Docs built, but excludes example gallery plots + [doc build] Docs built including example gallery plots + ====================== =================== + .. _filing_bugs: Filing Bugs From 7b94ea0c2e8d35136e529ea3210d23511572c548 Mon Sep 17 00:00:00 2001 From: alexandercbooth Date: Wed, 14 Dec 2016 21:38:12 -0800 Subject: [PATCH 8/9] chore(CI): remove CI/commit message magics --- CONTRIBUTING.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 018a57f6b4070..b28f8866b157d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,21 +113,6 @@ following rules before you submit a pull request: scale in dimensionality: n_features is expected to be lower than 100". -A Note about CI: ----------------- -- Travis is used for testing on Linux platforms -- Appveyor is used for testing on Windows platforms -- CircleCI is used to build the docs for viewing - - Please note that if one of the following markers appear in the latest commit message, the following actions are taken. - -Commit Message Marker | Action Taken by CI -----------|--------------- -[ci skip] | CI is skipped completely -[doc skip] | Docs are not built -[doc quick] | Docs built, but exclude example gallery plots -[doc build] | Docs built, including example gallery plots - You can also check for common programming errors with the following tools: From cc3121d58a0e26eb2d33e52cfd879d4fd2749e2b Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Thu, 15 Dec 2016 17:01:02 +1100 Subject: [PATCH 9/9] Fixed line wrapping --- doc/developers/contributing.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 48dbd1147677b..d97afefac5b0b 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -269,7 +269,9 @@ and Cython optimizations. * Appveyor is used for testing on Windows platforms * CircleCI is used to build the docs for viewing - Please note that if one of the following markers appear in the latest commit message, the following actions are taken. + Please note that if one of the following markers appear in the latest commit + message, the following actions are taken. + ====================== =================== Commit Message Marker Action Taken by CI ---------------------- -------------------