From 8d2d779ec1287b349ea55c91df80ae8788362c1f Mon Sep 17 00:00:00 2001 From: David Runge Date: Sun, 30 Jan 2022 21:08:30 +0100 Subject: Add info about adding a changelog entry for merge requests CONTRIBUTING.rst: Add info about adding a changelog entry for merge requests, explaining where in the file it needs to be added. --- CONTRIBUTING.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bffc49d..3c80f6e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -19,6 +19,14 @@ All ash and bash scripts are linted using shellcheck: make lint +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. + Testing ======= -- cgit v1.2.3-70-g09d2 From cd1438757647425abfa78fdba06e241c7da0db11 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sun, 30 Jan 2022 21:26:43 +0100 Subject: Add contributing guideline about merge requests CONTRIBUTING.rst: Elaborate on when merge requests are merged using `--no-ff` or `--ff`. --- CONTRIBUTING.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3c80f6e..ba8bf4a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -27,6 +27,20 @@ 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. + Testing ======= -- cgit v1.2.3-70-g09d2