diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b307d4e22e..5215a22027 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,18 @@ -Please fill in the fields below to submit a pull request. The more information -that is provided, the better. + **Description of the changes being introduced by the pull request**: -**Please verify and check that the pull request fulfills the following -requirements**: -- [ ] The code follows the [Code Style Guidelines](https://github.com/secure-systems-lab/code-style-guidelines#code-style-guidelines) -- [ ] Tests have been added for the bug fix or new feature -- [ ] Docs have been added for the bug fix or new feature +Fixes # + diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 94e10f6fb0..00bffc8e3c 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -13,6 +13,14 @@ and must be `unit tested <#unit-tests>`_. Also see `development installation instructions `_. +DCO +=== + +Contributors must indicate acceptance of the `Developer Certificate of +Origin `_ by appending a ``Signed-off-by: +Your Name `` to each git commit message (see `git commit +--signoff `_). + Testing ======= @@ -63,26 +71,9 @@ via PyPI). Auto-formatting --------------- -CI/CD will check that new TUF code is formatted with `black -`__ and `isort `__. -Auto-formatting can be done on the command line: +The linter in CI/CD will check that new TUF code is formatted with +`ruff `_. Auto-formatting can be done on the +command line: :: - $ black - $ isort - -or via source code editor plugin -[`black `__, -`isort `__] or -`pre-commit `__-powered git hooks -[`black `__, -`isort `__]. - - -DCO -=== - -Contributors must also indicate acceptance of the `Developer Certificate of -Origin `_ by appending a ``Signed-off-by: -Your Name `` to each git commit message (see `git commit ---signoff `_). + $ ruff format .