Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/contributing: Document Co-authored-by usage #242

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions content/en/docs/contributing/submitting-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <author-email>
Date: [...]

[...]

Co-authored-by: Co-Author 1 Name <co-author-1-email>
Co-authored-by: Co-Author 2 Name <co-author-2-email>
Signed-off-by: Author Name <author-email>
Signed-off-by: Co-Author 1 Name <co-author-1-email>
Signed-off-by: Co-Author 2 Name <co-author-2-email>
```

## Rebasing and Squashing

Expand Down