Add contributing guideline about merge requests

CONTRIBUTING.rst:
Elaborate on when merge requests are merged using `--no-ff` or `--ff`.
This commit is contained in:
David Runge 2022-01-30 21:26:43 +01:00
parent 8d2d779ec1
commit cd14387576
No known key found for this signature in database
GPG key ID: 7258734B41C31549

View file

@ -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 The changelog entry needs to be added to the unreleased section at the top, as that section is used for the next
release. release.
Merge requests and signed commits
=================================
Merge requests are not required to contain signed commits (using ``git commit -S`` - see `man 1 git-commit
<https://man.archlinux.org/man/git-commit.1>`_).
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
<https://man.archlinux.org/man/git-merge.1>`_) 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 Testing
======= =======