From 52ad5654894a2441c85159241b6e064060ee9704 Mon Sep 17 00:00:00 2001 From: Hatim Zahid <63000127+HatimZ@users.noreply.github.com> Date: Tue, 25 Oct 2022 09:41:09 -0700 Subject: [PATCH 1/5] Added pre-commit link inside the guideline --- doc/source/development/contributing_environment.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 4a70057cf18e3..089bba8a281b2 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -216,6 +216,16 @@ should already exist. python setup.py build_ext -j 4 python -m pip install -e . --no-build-isolation --no-use-pep517 +**Installing Pre-commit** + +In the root directory of the project run the below command to install the pre-commit tool. For more details on installing and usage of pre-commit,visit +`here `__. + +.. code-block:: powershell + + # Install pre-commit + pre-commit install + Option 2: creating an environment using Docker ---------------------------------------------- From cadfcbf9d9dc50a3a7f43141ddf58f86875a40d5 Mon Sep 17 00:00:00 2001 From: Hatim Zahid <63000127+HatimZ@users.noreply.github.com> Date: Thu, 27 Oct 2022 04:54:49 -0700 Subject: [PATCH 2/5] Updated the Text to install pre-commit hooks. --- doc/source/development/contributing_environment.rst | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 089bba8a281b2..bac33a731ccb3 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -216,15 +216,7 @@ should already exist. python setup.py build_ext -j 4 python -m pip install -e . --no-build-isolation --no-use-pep517 -**Installing Pre-commit** - -In the root directory of the project run the below command to install the pre-commit tool. For more details on installing and usage of pre-commit,visit -`here `__. - -.. code-block:: powershell - - # Install pre-commit - pre-commit install +Be sure to also install the `pre-commit hooks `__. Option 2: creating an environment using Docker ---------------------------------------------- From e54d39c33e32a4836cb081edd37e042d3fe6dedd Mon Sep 17 00:00:00 2001 From: Hatim Zahid <63000127+HatimZ@users.noreply.github.com> Date: Thu, 27 Oct 2022 07:08:10 -0700 Subject: [PATCH 3/5] Changed the https link to short form link. --- doc/source/development/contributing_environment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index bac33a731ccb3..780b4b0f3403d 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -216,7 +216,7 @@ should already exist. python setup.py build_ext -j 4 python -m pip install -e . --no-build-isolation --no-use-pep517 -Be sure to also install the `pre-commit hooks `__. +Be sure to also install the :ref:`pre-commit hooks ` Option 2: creating an environment using Docker ---------------------------------------------- From cb17db18399464d03068b5df09f0317abf3f87f8 Mon Sep 17 00:00:00 2001 From: Hatim Zahid <63000127+HatimZ@users.noreply.github.com> Date: Fri, 28 Oct 2022 00:38:19 -0700 Subject: [PATCH 4/5] Added a period at the end of the sentence --- doc/source/development/contributing_environment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 780b4b0f3403d..16142e681b702 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -216,7 +216,7 @@ should already exist. python setup.py build_ext -j 4 python -m pip install -e . --no-build-isolation --no-use-pep517 -Be sure to also install the :ref:`pre-commit hooks ` +Be sure to also install the :ref:`pre-commit hooks `. Option 2: creating an environment using Docker ---------------------------------------------- From 668749816bd963bbe72c391c7a19539912cf82d6 Mon Sep 17 00:00:00 2001 From: Hatim Zahid <63000127+HatimZ@users.noreply.github.com> Date: Fri, 28 Oct 2022 01:57:42 -0700 Subject: [PATCH 5/5] Changed location of pre-commit text and made it optional. --- doc/source/development/contributing_environment.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 16142e681b702..afa0d0306f1af 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -10,7 +10,7 @@ To test out code changes, you'll need to build pandas from source, which requires a C/C++ compiler and Python environment. If you're making documentation changes, you can skip to :ref:`contributing to the documentation ` but if you skip creating the development environment you won't be able to build the documentation -locally before pushing your changes. +locally before pushing your changes. It's recommended to also install the :ref:`pre-commit hooks `. .. contents:: Table of contents: :local: @@ -216,8 +216,6 @@ should already exist. python setup.py build_ext -j 4 python -m pip install -e . --no-build-isolation --no-use-pep517 -Be sure to also install the :ref:`pre-commit hooks `. - Option 2: creating an environment using Docker ----------------------------------------------