Skip to content

Commit 292fb0f

Browse files
authored
Updating Contributing guidelines and copy-pastable code (#2642)
* Make commands easier to copy Signed-off-by: h4l0gen <ks3913688@gmail.com> Signed-off-by: Kapil Sharma <ks3913688@gmail.com>
1 parent ecf2f08 commit 292fb0f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/CONTRIBUTING.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ tox run.
3131

3232
::
3333

34-
$ tox
34+
tox
3535

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

47-
$ cd tests/
48-
$ python3 aggregate_tests.py
47+
cd tests/
48+
python3 aggregate_tests.py
4949

5050

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

55-
$ cd tests/
56-
$ python3 test_updater_ng.py -v
55+
cd tests/
56+
python3 test_updater_ng.py -v
5757

5858

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

67-
$ cd tests/
68-
$ coverage run aggregate_tests.py && coverage report
67+
cd tests/
68+
coverage run aggregate_tests.py && coverage report
6969

7070

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

79-
$ tox -e fix
79+
tox -e fix

0 commit comments

Comments
 (0)