proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-05-29 07:35:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #6150 from ton31337/feature/black_topotests_developer_guide

Browse Source 
doc: Mention that we should use `black` code formatter for topotests
This commit is contained in:
David Lamparter 2020-04-06 17:39:20 +02:00 committed by GitHub
commit dc61176306
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/developer/topotests.rst
View File

@ -360,6 +360,7 @@ This is the recommended test writing routine:
- Write a topology (Graphviz recommended) - Write a topology (Graphviz recommended)
- Obtain configuration files - Obtain configuration files
- Write the test itself - Write the test itself
- Format the new code using `black <https://github.com/psf/black>`_
- Create a Pull Request - Create a Pull Request
Topotest File Hierarchy Topotest File Hierarchy
@ -760,6 +761,8 @@ Requirements:
inside folders named after the equipment. inside folders named after the equipment.
- Tests must be able to run without any interaction. To make sure your test - Tests must be able to run without any interaction. To make sure your test
conforms with this, run it without the :option:`-s` parameter. 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: Tips: