summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code/submitting-patches.txt
diff options
context:
space:
mode:
authorDavid Smith <smithdc@gmail.com>2020-12-15 20:32:08 +0000
committerCarlton Gibson <carlton@noumenal.es>2020-12-23 11:14:48 +0100
commit3bca95cca277a1e205c10d4fd3ea8527c6fcc34a (patch)
treec39e0b0309f3a81aebcbea0b54a80e35d5c7b00f /docs/internals/contributing/writing-code/submitting-patches.txt
parent3a0ed0ce3f2e38c4336da6d68d901c6f3d5926dc (diff)
Fixed #32165 -- Added pre-commit hooks
* Added pre-commit hooks for isort, flake8 and eslint * Added documentation on how to install and use the tool
Diffstat (limited to 'docs/internals/contributing/writing-code/submitting-patches.txt')
-rw-r--r--docs/internals/contributing/writing-code/submitting-patches.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt
index 45b2b9bdc4..161f6f8d6f 100644
--- a/docs/internals/contributing/writing-code/submitting-patches.txt
+++ b/docs/internals/contributing/writing-code/submitting-patches.txt
@@ -290,7 +290,9 @@ All code changes
* Does the :doc:`coding style
</internals/contributing/writing-code/coding-style>` conform to our
- guidelines? Are there any ``flake8`` errors?
+ guidelines? Are there any ``flake8`` errors? You can install the
+ :ref:`pre-commit <coding-style-pre-commit>` hooks to automatically catch
+ these errors.
* If the change is backwards incompatible in any way, is there a note
in the release notes (``docs/releases/A.B.txt``)?
* Is Django's test suite passing?