Table of Contents |
---|
...
Overview
The recommended best practice for all code submitted through a project hosted by the Linux Foundation AI&Data Foundation is to include a Developer Certificate of Origin (DCO) sign-off.
...
You can "sign" this certificate by including a line in the git commit of "Signed-off-by: Legal Name <email-address>
", using the email address associated with your GitHub account.
Why DCO
The DCO is a per-commit sign-off made by a contributor stating that they agree to the terms published at https://developercertificate.org/ for that particular contribution. DCO sign-offs differ from contributor agreements (CLAs):
...
There are several good articles on DCO in the References section below for more details.
How to work with DCO
When Committing
You need to ensure that every commit message has a line "Signed-off-by: Your Legal Name <your-email@address>
", and while you could add that manually every time, here are the steps to follow so the computer can add it for you:
- Set your legal name in the git configuration:
git config user.name "Legal Name"
- Set your email in the git configuration:
git config user.email "email@address"
- Add the
-s
or--signoff
to allgit commit
invocations.- Add a git alias:
git config --global alias.c 'commit --signoff'
and then run "git c
" instead of "git commit
" - In IntelliJ
- Add a git alias:
When Merging
The merge or a PR must also have a DCO so we can know the entire repository is under the associated license.
Squashed Merges
When Merging a Pull Request through "squash and merge", include the Signed-off-by
lines from every contributor, and add one for you as the person merging. This might require you to edit the comments as a part of the merge. Note: If you use the GitHub client, it should handle cleaning up any extraneous messages for you.
Handling Failures
When you have a DCO failure on your PR from DCO Bot
'
Click on that "Details" link and follow the instructions.
When you have a DCO failure on your PR from CI
On Circle CI you will see:
...
If the commit missing the signoff is on a non-main branch (eg merge
in the example above), and you are a maintainer, you should be able to force-push to that branch (eg rollback the most recent commit).
...
References
Anchor | ||||
---|---|---|---|---|
|
...