From fba8a56bc188f3a9fe26037a18014de1f22f07ab Mon Sep 17 00:00:00 2001 From: Joeperdefloep Date: Tue, 7 Sep 2021 09:38:56 +0200 Subject: [PATCH 1/5] DOC: add links to pre-commit in contributing --- doc/source/development/contributing.rst | 5 ++++- doc/source/development/contributing_environment.rst | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index f4a09e0daa750..f2a5297b40416 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -331,7 +331,10 @@ 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..7f307b75de005 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -133,6 +133,7 @@ compiler installation instructions. Let us know if you have any difficulties by opening an issue or reaching out on `Gitter `_. +.. _contributing.python-env Creating a Python environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 3f165917845c9d6c34dde1b7c5cbc614059166d4 Mon Sep 17 00:00:00 2001 From: Joeperdefloep Date: Tue, 7 Sep 2021 15:21:59 +0200 Subject: [PATCH 2/5] fixed link and period --- doc/source/development/contributing.rst | 2 +- doc/source/development/contributing_environment.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index f2a5297b40416..1c72835f5360a 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -334,7 +334,7 @@ can comment:: 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 ` +` , 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 7f307b75de005..53f1be79dd0e2 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -133,7 +133,7 @@ compiler installation instructions. Let us know if you have any difficulties by opening an issue or reaching out on `Gitter `_. -.. _contributing.python-env +.. _contributing.python-env: Creating a Python environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 838f1538d7625488f9737351e2f284cbfefed022 Mon Sep 17 00:00:00 2001 From: Joeperdefloep Date: Tue, 7 Sep 2021 16:06:33 +0200 Subject: [PATCH 3/5] some punctuation --- doc/source/development/contributing.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 1c72835f5360a..d68c137baecb9 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -332,9 +332,11 @@ can comment:: @github-actions pre-commit 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 +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 `. +` and then set up :ref:`pre-commit `. Delete your merged branch (optional) ------------------------------------ From 8b6be162f592c7ba0e55bc63e78490dc3ad6c207 Mon Sep 17 00:00:00 2001 From: Joeperdefloep Date: Tue, 7 Sep 2021 18:41:03 +0200 Subject: [PATCH 4/5] changed pull request template --- .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 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 From a80fa2763cc15616307752f54cef65c3f5d41dab Mon Sep 17 00:00:00 2001 From: Joeperdefloep Date: Tue, 7 Sep 2021 19:14:06 +0200 Subject: [PATCH 5/5] DOC: GH43441 clarified pre-commit in PR template --- doc/source/development/contributing.rst | 2 +- doc/source/development/contributing_environment.rst | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index d68c137baecb9..9b3d50069b077 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -336,7 +336,7 @@ 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 `. +` 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 53f1be79dd0e2..4c3c12eb9da92 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -133,8 +133,6 @@ compiler installation instructions. Let us know if you have any difficulties by opening an issue or reaching out on `Gitter `_. -.. _contributing.python-env: - Creating a Python environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~