]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: Mention that we should use `black` code formatter for topotests 6150/head
authorDonatas Abraitis <donatas.abraitis@gmail.com>
Fri, 3 Apr 2020 19:26:19 +0000 (22:26 +0300)
committerDonatas Abraitis <donatas.abraitis@gmail.com>
Sun, 5 Apr 2020 17:16:01 +0000 (20:16 +0300)
black - https://github.com/psf/black

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
doc/developer/topotests.rst

index 33ebe06d2fa4b033bafd47126e1bb6a06b7a716d..7e627781e009b8a8045acfe742dedc9f2bff6395 100644 (file)
@@ -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: