Skip to content

DOC: Added pre-commit link inside the guideline #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 25, 2022
Merged

DOC: Added pre-commit link inside the guideline #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/source/development/contributing_environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://pandas.pydata.org/pandas-docs/stable/development/contributing_codebase.html#pre-commit>`__.

.. code-block:: powershell

# Install pre-commit
pre-commit install

Option 2: creating an environment using Docker
----------------------------------------------

Expand Down