-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update contibuter docs to mention that DCO signoff is mandatory (#173)
Signed-off-by: Abhilash Shetty <[email protected]>
- Loading branch information
1 parent
0dc9a87
commit ed71215
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
|
@@ -89,6 +89,23 @@ For setting up a development environment on your local machine, see the detailed | |
* `test` - adding missing tests, refactoring tests; no production code change | ||
* `refactor` - refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes | ||
* `cherry-pick` - if PR is merged in the develop branch and raised to release branch(like v1.9.x) | ||
--- | ||
|
||
### Sign your work | ||
|
||
We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license. Please read [developer-certificate-of-origin](./contribute/developer-certificate-of-origin). | ||
|
||
Please certify it by just adding a line to every git commit message. Any PR with Commits which does not have DCO Signoff will not be accepted: | ||
|
||
``` | ||
Signed-off-by: Random J Developer <[email protected]> | ||
``` | ||
|
||
or use the command `git commit -s -m "commit message comes here"` to sign-off on your commits. | ||
|
||
Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed. | ||
|
||
--- | ||
|
||
## Code Reviews | ||
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) for more information on using pull requests. | ||
|