Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating Contributing guidelines and copy-pastable code #2642

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Updating Contributing guidelines and copy-pastable code #2642

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
717d177
adding copy button
h4l0gen May 25, 2024
0546962
Update conf.py
h4l0gen May 27, 2024
67289ab
Update docs.txt
h4l0gen May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/CONTRIBUTING.rst
View file
Open in desktop
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