From: Donatas Abraitis Date: Fri, 3 Apr 2020 19:26:19 +0000 (+0300) Subject: doc: Mention that we should use `black` code formatter for topotests X-Git-Tag: base_7.4~128^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=refs%2Fpull%2F6150%2Fhead;p=mirror%2Ffrr.git doc: Mention that we should use `black` code formatter for topotests black - https://github.com/psf/black Signed-off-by: Donatas Abraitis --- 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: