From 9dd78258ff85b710913807bbd36e0e5d81788488 Mon Sep 17 00:00:00 2001 From: Donatas Abraitis Date: Fri, 3 Apr 2020 22:26:19 +0300 Subject: [PATCH] doc: Mention that we should use `black` code formatter for topotests black - https://github.com/psf/black Signed-off-by: Donatas Abraitis --- doc/developer/topotests.rst | 3 +++ 1 file changed, 3 insertions(+) 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 `_ - 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 `_ code formatter before creating + a pull request. This ensures we have a unified code style. Tips: