diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7fb5a6ddf2024..42017db8a05b1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ - [ ] closes #xxxx - [ ] tests added / passed -- [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) for how to run them +- [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit) for how to run them - [ ] whatsnew entry diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index f4a09e0daa750..9b3d50069b077 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -331,7 +331,12 @@ can comment:: @github-actions pre-commit -on that pull request. This will trigger a workflow which will autofix formatting errors. +on that pull request. This will trigger a workflow which will autofix formatting +errors. + +To automatically fix formatting errors on each commit you make, you can +set up pre-commit yourself. First, create a Python :ref:`environment +` and then set up :ref:`pre-commit `. Delete your merged branch (optional) ------------------------------------ diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 1f9b34c7a784e..4c3c12eb9da92 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -133,7 +133,6 @@ compiler installation instructions. Let us know if you have any difficulties by opening an issue or reaching out on `Gitter `_. - Creating a Python environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~