diff options
| author | David Lamparter <equinox@opensourcerouting.org> | 2020-04-06 17:39:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-06 17:39:20 +0200 |
| commit | dc61176306ea68adf59bccc74b6c311971113bc2 (patch) | |
| tree | d031bd914e796146dd695cdba722216a839a2383 | |
| parent | f728a3bb992767137a47ba09209d7712ff70ead5 (diff) | |
| parent | 9dd78258ff85b710913807bbd36e0e5d81788488 (diff) | |
Merge pull request #6150 from ton31337/feature/black_topotests_developer_guide
doc: Mention that we should use `black` code formatter for topotests
| -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 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: |