-
Notifications
You must be signed in to change notification settings - Fork 79
docs: add DCO 1.1 text and contributor sign-off guide #359
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
Open
Zhifu-Liu
wants to merge
4
commits into
RL-Align:main
Choose a base branch
from
Zhifu-Liu:docs/dco-contributing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
e74b541
docs: add DCO 1.1 text and contributor sign-off guide
Zhifu-Liu 72148dd
docs: clarify bot sign-off policy for DCO
Zhifu-Liu 3168a28
docs: reconcile blanket sign-off rule with bot exemption
Zhifu-Liu 9318682
docs: scope the sign-off guarantee and clarify email association
Zhifu-Liu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| # Contributing to RL-Kernel | ||
|
|
||
| Thank you for your interest in contributing to RL-Kernel. Bug reports, feature | ||
| requests, documentation improvements, and code contributions are all welcome. | ||
|
|
||
| - For bugs and feature requests, please | ||
| [open an issue](https://github.com/RL-Align/RL-Kernel/issues) first. | ||
| - For code changes, open a pull request against `main` and keep it focused on | ||
| a single topic. | ||
| - For questions and discussion, reach the community on | ||
| [Slack](https://rl-align.slack.com) or [WeChat](./docs/community/wechat.md). | ||
|
|
||
| ## Sign your work (DCO) | ||
|
|
||
| Every commit in a pull request must carry a `Signed-off-by:` trailer, per the | ||
| [Developer Certificate of Origin](./DCO) (DCO), version 1.1. The DCO check is | ||
| enforced as a required status check on every pull request. The only exception | ||
| is automation explicitly exempted in the DCO app configuration (see the | ||
| signing policies below). | ||
|
|
||
| By signing off, you certify that you wrote the change or otherwise have the | ||
| right to submit it under the project's open source license. | ||
|
|
||
| Sign a new commit: | ||
|
|
||
| ```bash | ||
| git commit -s | ||
| ``` | ||
|
|
||
| This appends `Signed-off-by: Your Name <your.email@example.com>` to the commit | ||
| message. | ||
|
|
||
| Repair commits you have already pushed (for example, when the DCO check | ||
| reports a missing sign-off). If you work from a fork, rebase onto the upstream | ||
| repository: | ||
|
|
||
| ```bash | ||
| git remote add upstream https://github.com/RL-Align/RL-Kernel.git # once, if missing | ||
| git fetch upstream | ||
| git rebase --signoff upstream/main | ||
| git push --force-with-lease | ||
| ``` | ||
|
|
||
| If you cloned the project repository directly, rebase onto `origin/main` | ||
| instead: | ||
|
|
||
| ```bash | ||
| git fetch origin | ||
| git rebase --signoff origin/main | ||
| git push --force-with-lease | ||
| ``` | ||
|
|
||
| The DCO check validates the **email address**: the `Signed-off-by:` email | ||
| must match the commit author email. `git commit -s` and | ||
| `git rebase --signoff` sign with your configured `user.name` and | ||
| `user.email` — the **committer** identity. The sign-off therefore matches | ||
| whenever you are also the commit's author, which is the normal case for | ||
| your own work: | ||
|
|
||
| ```text | ||
| Author: Your Name <your.email@example.com> | ||
| Signed-off-by: Your Name <your.email@example.com> | ||
| ``` | ||
|
|
||
| Your own sign-off cannot repair a commit authored by someone else — for | ||
| example one you cherry-picked or applied from a patch: the trailer records | ||
| your identity and will not match their author email. Such commits need a | ||
| sign-off from their own author. Automation that cannot carry a matching | ||
| sign-off falls under the exemption described in the signing policies below. | ||
|
|
||
| Sign with a name that identifies you to the project — your real name, or a | ||
| name or handle linked to your GitHub account. The automated check compares | ||
| only the email; the name is what maintainers use to recognize who made the | ||
| certification. | ||
|
|
||
| ### Email matching | ||
|
|
||
| If you contribute from several machines, keep `git config user.email` | ||
| consistent, and use an address associated with your GitHub account so commits | ||
| are attributed to you. The DCO check itself only compares the commit author | ||
| email with the sign-off email. | ||
|
|
||
| ### Signing policies | ||
|
|
||
| - `Co-authored-by:` trailers do not replace `Signed-off-by:`; each commit must | ||
| be signed off by its own author. | ||
| - Commits authored by bots or other automation must satisfy the email-match | ||
| rule like any other commit: the sign-off must carry the bot's own author | ||
| email. Automation that cannot sign its own commits may instead be exempted | ||
| in the DCO app configuration — the only exception to the rule above. A | ||
| human who submits or merges automation results remains responsible for | ||
| the change. | ||
| - AI-assisted contributions are welcome. The human submitter signs off and | ||
| remains responsible for the correctness and licensing of the contribution. | ||
|
|
||
| ## Pull requests opened before the DCO check was enabled | ||
|
|
||
| For pull requests created before the DCO check became a required status check, | ||
| maintainers will leave a one-time comment pointing to this guide. Authors are | ||
| asked to add the missing sign-offs within a four-week grace period. Pull | ||
| requests that still fail the DCO check after the grace period may be closed, | ||
| with an invitation to reopen once the commits are signed. | ||
|
|
||
| ## Development guide | ||
|
|
||
| For setting up a development environment, running tests, and documentation | ||
| conventions, see the [developer guide](./docs/contributing/README.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| Developer Certificate of Origin | ||
| Version 1.1 | ||
|
|
||
| Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
|
|
||
| Everyone is permitted to copy and distribute verbatim copies of this | ||
| license document, but changing it is not allowed. | ||
|
|
||
| Developer's Certificate of Origin 1.1 | ||
|
|
||
| By making a contribution to this project, I certify that: | ||
|
|
||
| (a) The contribution was created in whole or in part by me and I | ||
| have the right to submit it under the open source license | ||
| indicated in the file; or | ||
|
|
||
| (b) The contribution is based upon previous work that, to the best | ||
| of my knowledge, is covered under an appropriate open source | ||
| license and I have the right under that license to submit that | ||
| work with modifications, whether created in whole or in part | ||
| by me, under the same open source license (unless I am | ||
| permitted to submit under a different license), as indicated | ||
| in the file; or | ||
|
|
||
| (c) The contribution was provided directly to me by some other | ||
| person who certified (a), (b) or (c) and I have not modified | ||
| it. | ||
|
|
||
| (d) I understand and agree that this project and the contribution | ||
| are public and that a record of the contribution (including all | ||
| personal information I submit with it, including my sign-off) is | ||
| maintained indefinitely and may be redistributed consistent with | ||
| this project or the open source license(s) involved. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.