This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion-python.git
The following commit(s) were added to refs/heads/main by this push:
new 37c91f4 docs: include pre-commit hooks section in contributor guide
(#455)
37c91f4 is described below
commit 37c91f4458daa11f50c313e036761f7494ab27f9
Author: Daniel Mesejo <[email protected]>
AuthorDate: Fri Aug 11 21:45:21 2023 +0200
docs: include pre-commit hooks section in contributor guide (#455)
---
README.md | 6 +++---
docs/source/contributor-guide/introduction.rst | 9 +++++++++
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 506a382..a682f73 100644
--- a/README.md
+++ b/README.md
@@ -222,11 +222,11 @@ python -m pytest
### Running & Installing pre-commit hooks
-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.
+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.
-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.
+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.
-The pre-commit hooks can also be ran ad-hoc without installing them by simply
running `pre-commit run --all-files`
+The pre-commit hooks can also be run adhoc without installing them by simply
running `pre-commit run --all-files`
## How to update dependencies
diff --git a/docs/source/contributor-guide/introduction.rst
b/docs/source/contributor-guide/introduction.rst
index dd61ad8..6de2b87 100644
--- a/docs/source/contributor-guide/introduction.rst
+++ b/docs/source/contributor-guide/introduction.rst
@@ -62,6 +62,15 @@ Whenever rust code changes (your changes or via `git pull`):
maturin develop
python -m pytest
+Running & Installing pre-commit hooks
+-------------------------------------
+
+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.
+
+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.
+
+The pre-commit hooks can also be run adhoc without installing them by simply
running :code:`pre-commit run --all-files`
+
Update Dependencies
-------------------
