summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2023-05-17 10:35:50 -0700
committerGitHub <noreply@github.com>2023-05-17 13:35:50 -0400
commit458f0a952b61fcc68e36e16c73c33114a8c31b55 (patch)
tree8c3a435168125bf767bf79ab0e9d9d11b3de7e0c
parent5f2f88f6afc385892d91c20676d7dc6aa80d52bb (diff)
downloadnetworkx-458f0a952b61fcc68e36e16c73c33114a8c31b55.tar.gz
Add linting to contributor guide. (#6692)
Add linting step to contributor guide.
-rw-r--r--CONTRIBUTING.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 30024e29..d6acb2b7 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -108,6 +108,20 @@ Development Workflow
problems early and reduces the load on the continuous integration
system.
+4. Ensure your contribution is properly formatted.
+
+ * If you installed ``pre-commit`` as recommended in step 1, all necessary
+ linting should run automatically at commit time. If there are any
+ formatting issues, the commit will not be successful and linting
+ suggestions will be applied to the patch automatically.
+ Simply ``git add`` and ``git commit`` a second time to accept the proposed
+ formatting changes.
+
+ * If the above fails for whatever reason, you can also run the linter over
+ the entire codebase with::
+
+ pre-commit run --all-files
+
4. Submit your contribution:
* Push your changes back to your fork on GitHub::