Skip to content

Commit 1b03ac2

Browse files
committed
docs: Improve CONTRIBUTING
* Remove outdated info on linters * Move DCO info to the top: no-one will find it in the bottom Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
1 parent d8a43ac commit 1b03ac2

1 file changed

Lines changed: 12 additions & 21 deletions

File tree

docs/CONTRIBUTING.rst

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ and must be `unit tested <#unit-tests>`_.
1313

1414
Also see `development installation instructions <https://theupdateframework.readthedocs.io/en/latest/INSTALLATION.html#install-for-development>`_.
1515

16+
DCO
17+
===
18+
19+
Contributors must indicate acceptance of the `Developer Certificate of
20+
Origin <https://developercertificate.org/>`_ by appending a ``Signed-off-by:
21+
Your Name <example@domain.com>`` to each git commit message (see `git commit
22+
--signoff <https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff>`_).
23+
1624
Testing
1725
=======
1826

@@ -63,26 +71,9 @@ via PyPI).
6371
Auto-formatting
6472
---------------
6573

66-
CI/CD will check that new TUF code is formatted with `black
67-
<https://black.readthedocs.io/>`__ and `isort <https://pycqa.github.io/isort>`__.
68-
Auto-formatting can be done on the command line:
74+
The linter in CI/CD will check that new TUF code is formatted with
75+
`ruff<https://docs.astral.sh/ruff/>`__. Auto-formatting can be done on the
76+
command line:
6977
::
7078

71-
$ black <filename>
72-
$ isort <filename>
73-
74-
or via source code editor plugin
75-
[`black <https://black.readthedocs.io/en/stable/editor_integration.html>`__,
76-
`isort <https://github.com/pycqa/isort/wiki/isort-Plugins>`__] or
77-
`pre-commit <https://pre-commit.com/>`__-powered git hooks
78-
[`black <https://black.readthedocs.io/en/stable/version_control_integration.html>`__,
79-
`isort <https://pycqa.github.io/isort/docs/configuration/pre-commit/>`__].
80-
81-
82-
DCO
83-
===
84-
85-
Contributors must also indicate acceptance of the `Developer Certificate of
86-
Origin <https://developercertificate.org/>`_ by appending a ``Signed-off-by:
87-
Your Name <example@domain.com>`` to each git commit message (see `git commit
88-
--signoff <https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff>`_).
79+
$ ruff format .

0 commit comments

Comments
 (0)