From 8268f042bc7b76612b394a0ca69eab5caee98db4 Mon Sep 17 00:00:00 2001 From: Stefan Jumarea Date: Mon, 8 May 2023 13:59:03 +0300 Subject: [PATCH] docs/contributing: Document Co-authored-by usage Since we started using `Co-authored-by:` tags in commit messages, this should be documented on the `contributing/` page. Signed-off-by: Stefan Jumarea --- .../en/docs/contributing/submitting-changes.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/content/en/docs/contributing/submitting-changes.md b/content/en/docs/contributing/submitting-changes.md index 1c415f24..8f97369e 100644 --- a/content/en/docs/contributing/submitting-changes.md +++ b/content/en/docs/contributing/submitting-changes.md @@ -136,6 +136,21 @@ Each author should have their name added as part of the respective commit. Unikraft OSS project adopts a similar process seen with the Linux kernel, where a new merge request or PR can have multiple authors, multiple reviewers, testers, acknowledgements and more. Each author **must** add a `Signed-off-by` message, in order to certify that the submission is published under the [`DCO`](docs/contributing/submitting-changes/#developers-certificate-of-origin). +The co-authors should also add a `Co-authored-by` line to the commit message. +This should be done for every author except the one that actually created the commit, so the output of `git log` will look something like this: + +```console +Author: Author Name +Date: [...] + + [...] + + Co-authored-by: Co-Author 1 Name + Co-authored-by: Co-Author 2 Name + Signed-off-by: Author Name + Signed-off-by: Co-Author 1 Name + Signed-off-by: Co-Author 2 Name +``` ## Rebasing and Squashing