diff options
| author | Donatas Abraitis <donatas.abraitis@gmail.com> | 2020-04-03 21:26:19 +0200 |
|---|---|---|
| committer | Donatas Abraitis <donatas.abraitis@gmail.com> | 2020-04-05 19:16:01 +0200 |
| commit | 9dd78258ff85b710913807bbd36e0e5d81788488 (patch) | |
| tree | fa25d9c3b550cb6dbd601b01b34319e9562885b2 /doc/developer/topotests.rst | |
| parent | Merge pull request #6071 from ton31337/feature/rfc6286 (diff) | |
| download | frr-9dd78258ff85b710913807bbd36e0e5d81788488.tar.xz frr-9dd78258ff85b710913807bbd36e0e5d81788488.zip | |
doc: Mention that we should use `black` code formatter for topotests
black - https://github.com/psf/black
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
Diffstat (limited to 'doc/developer/topotests.rst')
| -rw-r--r-- | doc/developer/topotests.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 33ebe06d2..7e627781e 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: |