From 9080ad635cbef5b27b2bf269e892a3d09dc39d18 Mon Sep 17 00:00:00 2001 From: David Runge Date: Mon, 31 Jan 2022 18:37:39 +0100 Subject: Extend contributing guidelines by merge request and changelog info CONTRIBUTING.rst: Add infos around how to use the changelog when providing changes and how merge requests are handled by the maintainers of the project. --- CONTRIBUTING.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4dc8a77..7e097b1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -18,3 +18,25 @@ All ash and bash scripts are linted using shellcheck: .. code:: bash make check + +Changelog +========= + +When adding, changing or removing something in a merge request, add a sentence to the `CHANGELOG.rst `_ +explaining it. +The changelog entry needs to be added to the unreleased section at the top, as that section is used for the next +release. + +Merge requests and signed commits +================================= + +Merge requests are not required to contain signed commits (using ``git commit -S`` - see `man 1 git-commit +`_). +The project maintainers may rebase a given merge request branch at their discretion (if possible), which may remove +signed commits. + +The tip of the project's default branch is required to be a signed commit by the project maintainers. +For external contributors this means, that their merge request will be merged using ``--no-ff`` (see `man 1 git-merge +`_) in a signed merge commit, while contributions by the project maintainers +may be merged using ``--ff`` when the top-most commit of the source branch is signed by a valid PGP key of the given +maintainer. -- cgit v1.2.3-54-g00ecf