summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/developer/topotests.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index 33ebe06d2f..7e627781e0 100644
--- a/doc/developer/topotests.rst
+++ b/doc/developer/topotests.rst
@@ -360,6 +360,7 @@ This is the recommended test writing routine:
- Write a topology (Graphviz recommended)
- Obtain configuration files
- Write the test itself
+- Format the new code using `black <https://github.com/psf/black>`_
- Create a Pull Request
Topotest File Hierarchy
@@ -760,6 +761,8 @@ Requirements:
inside folders named after the equipment.
- Tests must be able to run without any interaction. To make sure your test
conforms with this, run it without the :option:`-s` parameter.
+- Use `black <https://github.com/psf/black>`_ code formatter before creating
+ a pull request. This ensures we have a unified code style.
Tips: