Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorDavid Runge <dvzrv@archlinux.org>2022-01-30 21:26:43 +0100
committerDavid Runge <dvzrv@archlinux.org>2022-01-30 21:26:43 +0100
commitcd1438757647425abfa78fdba06e241c7da0db11 (patch)
tree6c4d02768c531c00dbcff44b390e916183c39545 /CONTRIBUTING.rst
parent8d2d779ec1287b349ea55c91df80ae8788362c1f (diff)
Add contributing guideline about merge requests
CONTRIBUTING.rst: Elaborate on when merge requests are merged using `--no-ff` or `--ff`.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst14
1 files changed, 14 insertions, 0 deletions
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
+<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
=======