Skip to content

Commit

Permalink
Updating Contributing guidelines and copy-pastable code (#2642)
Browse files Browse the repository at this point in the history
* Make commands easier to copy

Signed-off-by: h4l0gen <ks3913688@gmail.com>
Signed-off-by: Kapil Sharma <ks3913688@gmail.com>
  • Loading branch information
h4l0gen authored Jun 4, 2024
1 parent ecf2f08 commit 292fb0f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ tox run.

::

$ tox
tox

Below, you will see more details about each step managed by ``tox``, in case
you need debug/run outside ``tox``.
Expand All @@ -44,16 +44,16 @@ the test aggregation script inside the *tests* subdirectory. ``tuf`` and its
dependencies must already be installed.
::

$ cd tests/
$ python3 aggregate_tests.py
cd tests/
python3 aggregate_tests.py


Individual tests can also be executed. Optional ``-v`` flags can be added to
increase log level up to DEBUG (``-vvvv``).
::

$ cd tests/
$ python3 test_updater_ng.py -v
cd tests/
python3 test_updater_ng.py -v


Coverage
Expand All @@ -64,8 +64,8 @@ invoked with the ``coverage`` tool (requires installation of ``coverage``, e.g.
via PyPI).
::

$ cd tests/
$ coverage run aggregate_tests.py && coverage report
cd tests/
coverage run aggregate_tests.py && coverage report


Auto-formatting
Expand All @@ -76,4 +76,4 @@ The linter in CI/CD will check that new TUF code is formatted with
command line:
::

$ tox -e fix
tox -e fix

0 comments on commit 292fb0f

Please sign in to comment.