Skip to content

DOC: add links to pre-commit in contributing #43441

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 5 commits into from
Sep 8, 2021
Merged

DOC: add links to pre-commit in contributing #43441

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fba8a56
DOC: add links to pre-commit in contributing
Sep 7, 2021
3f16591
fixed link and period
Sep 7, 2021
838f153
some punctuation
Sep 7, 2021
8b6be16
changed pull request template
Sep 7, 2021
a80fa27
DOC: GH43441 clarified pre-commit in PR template
Sep 7, 2021
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
5 changes: 4 additions & 1 deletion doc/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<contributing.python-env>` , and then set up :ref:`pre-commit <contributing.pre-commit>`

Delete your merged branch (optional)
------------------------------------
Expand Down
1 change: 1 addition & 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 @@ -133,6 +133,7 @@ compiler installation instructions.

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

.. _contributing.python-env

Creating a Python environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down