From 5761c9c70011a708a8d2016e22a27b6309050de1 Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Fri, 25 Dec 2020 19:27:14 +0530 Subject: [PATCH 01/13] Updated PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7c3870470f074..79545e57d8042 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,4 @@ - [ ] closes #xxxx - [ ] tests added / passed -- [ ] passes `black pandas` -- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff` +- [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` - [ ] whatsnew entry From c3f0487856526fd4b275e39e76289ddc7ef562de Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Sat, 26 Dec 2020 09:52:01 +0530 Subject: [PATCH 02/13] Added issue number --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 79545e57d8042..906a95a22205a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -- [ ] closes #xxxx +- [ ] closes #38694 - [ ] tests added / passed - [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` - [ ] whatsnew entry From 13cb90e5037f42a19f8ba194202bccd68f555432 Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Sat, 26 Dec 2020 15:30:28 +0530 Subject: [PATCH 03/13] Change reverted --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 906a95a22205a..79545e57d8042 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -- [ ] closes #38694 +- [ ] closes #xxxx - [ ] tests added / passed - [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` - [ ] whatsnew entry From b2277ffab46f83ff80ccc30088f0edb8723514c2 Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Thu, 31 Dec 2020 11:57:12 +0530 Subject: [PATCH 04/13] Added link to docs --- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 79545e57d8042..92cbdb4c169b8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,6 @@ -- [ ] closes #xxxx -- [ ] tests added / passed -- [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` -- [ ] whatsnew entry +* [ ] closes [#38696](https://github.com/pandas-dev/pandas/issues/38694) +* [ ] tests added / passed +* [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` +* [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) how to run them +* [ ] whatsnew entry + From df66eabdd23d9f71f9d2aae4a6541ef1030fa10f Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Thu, 31 Dec 2020 12:09:19 +0530 Subject: [PATCH 05/13] Removed unwanted spaces --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 92cbdb4c169b8..876c39166443b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,4 +3,3 @@ * [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` * [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) how to run them * [ ] whatsnew entry - From 3f7fd6780afcc35e8747f40f818224d372da2ca2 Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Thu, 31 Dec 2020 23:05:38 +0530 Subject: [PATCH 06/13] Modified code standards section --- doc/source/development/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index b810c71e3daa6..9e9fcb870fdc5 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -649,7 +649,7 @@ Thus, good style is a requirement for submitting code to pandas. There is a tool in pandas to help contributors verify their changes before contributing them to the project:: - ./ci/code_checks.sh + `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` The script verifies the linting of code files, it looks for common mistake patterns (like missing spaces around sphinx directives that make the documentation not From d52c4f4ef92ca20f230e8ed098fc369a6cc3e760 Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Thu, 31 Dec 2020 23:07:26 +0530 Subject: [PATCH 07/13] Reverted one checkbox --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 876c39166443b..7fac49bc4c1d9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ -* [ ] closes [#38696](https://github.com/pandas-dev/pandas/issues/38694) -* [ ] tests added / passed -* [ ] passes `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` -* [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) how to run them -* [ ] whatsnew entry +- [ ] closes [#38696](https://github.com/pandas-dev/pandas/issues/38694) +- [ ] tests added / passed +- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff` +- [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) for how to run them +- [ ] whatsnew entry From 9b5ed55a346e739ab762e598de7c43a14dacd738 Mon Sep 17 00:00:00 2001 From: Bobin Mathew <32351527+BobinMathew@users.noreply.github.com> Date: Thu, 31 Dec 2020 23:44:34 +0530 Subject: [PATCH 08/13] Removed `` --- doc/source/development/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 9e9fcb870fdc5..9c437bb8899bf 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -649,7 +649,7 @@ Thus, good style is a requirement for submitting code to pandas. There is a tool in pandas to help contributors verify their changes before contributing them to the project:: - `pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files` + pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files The script verifies the linting of code files, it looks for common mistake patterns (like missing spaces around sphinx directives that make the documentation not From 93a6ca68ad54fcfb589a1c2f93d07d62b39e2a5f Mon Sep 17 00:00:00 2001 From: Bobin Mathew Date: Sun, 3 Jan 2021 16:19:57 +0530 Subject: [PATCH 09/13] Reverted to 'closes #xxxx' --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7fac49bc4c1d9..4ab8afa739796 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -- [ ] closes [#38696](https://github.com/pandas-dev/pandas/issues/38694) +- [ ] closes #xxxx - [ ] tests added / passed - [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff` - [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) for how to run them From 23836d21542f2dbbd163c42ca520986490ba1624 Mon Sep 17 00:00:00 2001 From: Bobin Mathew Date: Sun, 3 Jan 2021 16:21:20 +0530 Subject: [PATCH 10/13] Removed one "pass" check --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4ab8afa739796..7fb5a6ddf2024 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,4 @@ - [ ] closes #xxxx - [ ] tests added / passed -- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff` - [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) for how to run them - [ ] whatsnew entry From 23e20f90c37af8138042eab8545411f6c7cc1e84 Mon Sep 17 00:00:00 2001 From: Bobin Mathew Date: Sun, 3 Jan 2021 16:27:33 +0530 Subject: [PATCH 11/13] Update contributing.rst --- doc/source/development/contributing.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 9c437bb8899bf..5004a2135aca4 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -649,9 +649,13 @@ Thus, good style is a requirement for submitting code to pandas. There is a tool in pandas to help contributors verify their changes before contributing them to the project:: - pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files + pre-commit run --all-files + +or, to only check files which were modified:: -The script verifies the linting of code files, it looks for common mistake patterns + pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files + +The command verifies the linting of code files, it looks for common mistake patterns (like missing spaces around sphinx directives that make the documentation not being rendered properly) and it also validates the doctests. It is possible to run the checks independently by using the parameters ``lint``, ``patterns`` and From 222c6129b94281f4f771c5679607902369a24189 Mon Sep 17 00:00:00 2001 From: Bobin Mathew Date: Sun, 3 Jan 2021 16:41:23 +0530 Subject: [PATCH 12/13] Update contributing.rst --- doc/source/development/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 5004a2135aca4..929a376986f0f 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -650,11 +650,11 @@ There is a tool in pandas to help contributors verify their changes before contributing them to the project:: pre-commit run --all-files - + or, to only check files which were modified:: pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files - + The command verifies the linting of code files, it looks for common mistake patterns (like missing spaces around sphinx directives that make the documentation not being rendered properly) and it also validates the doctests. It is possible to From e6c716b60266183127fbcaee6498c6d88f9bad1e Mon Sep 17 00:00:00 2001 From: Bobin Mathew Date: Sun, 3 Jan 2021 22:30:18 +0530 Subject: [PATCH 13/13] Reverted contributing.rst --- doc/source/development/contributing.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 929a376986f0f..b810c71e3daa6 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -649,13 +649,9 @@ Thus, good style is a requirement for submitting code to pandas. There is a tool in pandas to help contributors verify their changes before contributing them to the project:: - pre-commit run --all-files + ./ci/code_checks.sh -or, to only check files which were modified:: - - pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files - -The command verifies the linting of code files, it looks for common mistake patterns +The script verifies the linting of code files, it looks for common mistake patterns (like missing spaces around sphinx directives that make the documentation not being rendered properly) and it also validates the doctests. It is possible to run the checks independently by using the parameters ``lint``, ``patterns`` and