summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Mayer <entroP@gmail.com>2020-11-20 16:30:18 +0100
committerJustin Mayer <entroP@gmail.com>2020-11-20 16:30:18 +0100
commita9d9ccb58300c467d0b2aa721f5189706583a0b4 (patch)
tree6559209c1b64e9da7e6a5644eab44c1b5e3d25db
parentf21969a0161621642f60139b5735190ee633e7e6 (diff)
downloadpelican-a9d9ccb58300c467d0b2aa721f5189706583a0b4.tar.gz
Improve docs for plugin code style compliance
-rw-r--r--docs/contribute.rst13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/contribute.rst b/docs/contribute.rst
index 2e1dc317..a86a5031 100644
--- a/docs/contribute.rst
+++ b/docs/contribute.rst
@@ -148,9 +148,20 @@ Create a topic branch for your plugin bug fix or feature::
git checkout -b name-of-your-bugfix-or-feature
-After writing new tests for your plugin changes, run the plugin test suite::
+After writing new tests for your plugin changes, run the plugin test suite and
+check for code style compliance via::
invoke tests
+ invoke lint
+
+If style violations are found, many of them can be addressed automatically via::
+
+ invoke black
+ invoke isort
+
+If style violations are found even after running the above auto-formatters,
+you will need to make additional manual changes until ``invoke lint`` no longer
+reports any code style violations.
.. _plugin template: https://github.com/getpelican/cookiecutter-pelican-plugin
.. _Simple Footnotes: https://github.com/pelican-plugins/simple-footnotes