Skip to content

Commit 819002c

Browse files
authored
DOC: add links to pre-commit in contributing (#43441)
* DOC: add links to pre-commit in contributing * fixed link and period * some punctuation * changed pull request template * DOC: GH43441 clarified pre-commit in PR template
1 parent bc94e28 commit 819002c

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
- [ ] closes #xxxx
22
- [ ] tests added / passed
3-
- [ ] Ensure all linting tests pass, see [here](https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#code-standards) for how to run them
3+
- [ ] 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
44
- [ ] whatsnew entry

doc/source/development/contributing.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,12 @@ can comment::
331331

332332
@github-actions pre-commit
333333

334-
on that pull request. This will trigger a workflow which will autofix formatting errors.
334+
on that pull request. This will trigger a workflow which will autofix formatting
335+
errors.
336+
337+
To automatically fix formatting errors on each commit you make, you can
338+
set up pre-commit yourself. First, create a Python :ref:`environment
339+
<contributing_environment>` and then set up :ref:`pre-commit <contributing.pre-commit>`.
335340

336341
Delete your merged branch (optional)
337342
------------------------------------

doc/source/development/contributing_environment.rst

-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,6 @@ compiler installation instructions.
133133

134134
Let us know if you have any difficulties by opening an issue or reaching out on `Gitter <https://gitter.im/pydata/pandas/>`_.
135135

136-
137136
Creating a Python environment
138137
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139138

0 commit comments

Comments
 (0)