Skip to content

Commit df7fc85

Browse files
committed
docs: include pre-commit hooks section in contributor guide
1 parent 1fde8e4 commit df7fc85

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,11 @@ python -m pytest
222222

223223
### Running & Installing pre-commit hooks
224224

225-
arrow-datafusion-python takes advantage of (pre-commit)[https://pre-commit.com/] to assist developers in with code linting to help reduce the number of commits that ultimately fail in CI due to linter errors. Using the pre-commit hooks is optional for the developer but certainly helpful for keep PRs clean and concise.
225+
arrow-datafusion-python takes advantage of [pre-commit](https://pre-commit.com/) to assist developers with code linting to help reduce the number of commits that ultimately fail in CI due to linter errors. Using the pre-commit hooks is optional for the developer but certainly helpful for keeping PRs clean and concise.
226226

227-
Our pre-commit hooks can be installed by running `pre-commit install` which will install the configurations in your ARROW_DATAFUSION_PYTHON_ROOT/.github directory and run each time you perform a commit failing to perform the commit if an offending lint is found giving you the opportunity to make changes locally before pushing.
227+
Our pre-commit hooks can be installed by running `pre-commit install`, which will install the configurations in your ARROW_DATAFUSION_PYTHON_ROOT/.github directory and run each time you perform a commit, failing to complete the commit if an offending lint is found allowing you to make changes locally before pushing.
228228

229-
The pre-commit hooks can also be ran ad-hoc without installing them by simply running `pre-commit run --all-files`
229+
The pre-commit hooks can also be run adhoc without installing them by simply running `pre-commit run --all-files`
230230

231231
## How to update dependencies
232232

docs/source/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,15 @@ Whenever rust code changes (your changes or via `git pull`):
259259
maturin develop
260260
python -m pytest
261261
262+
Running & Installing pre-commit hooks
263+
=====================================
264+
265+
arrow-datafusion-python takes advantage of `pre-commit <https://pre-commit.com/>`_ to assist developers with code linting to help reduce the number of commits that ultimately fail in CI due to linter errors. Using the pre-commit hooks is optional for the developer but certainly helpful for keeping PRs clean and concise.
266+
267+
Our pre-commit hooks can be installed by running :code:`pre-commit install`, which will install the configurations in your ARROW_DATAFUSION_PYTHON_ROOT/.github directory and run each time you perform a commit, failing to complete the commit if an offending lint is found allowing you to make changes locally before pushing.
268+
269+
The pre-commit hooks can also be run adhoc without installing them by simply running :code:`pre-commit run --all-files`
270+
262271

263272
How to update dependencies
264273
==========================

0 commit comments

Comments
 (0)