-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from hyperlight-dev/dco
add dco to the contributing.md
- Loading branch information
Showing
1 changed file
with
79 additions
and
11 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 |
---|---|---|
@@ -1,14 +1,82 @@ | ||
# Contributing | ||
# Contribution Guidelines | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to | ||
agree to a Contributor License Agreement (CLA) declaring that you have the right to, | ||
and actually do, grant us the rights to use your contribution. For details, visit | ||
https://cla.microsoft.com. | ||
This project welcomes contributions. Most contributions require you to signoff on your commits via | ||
the Developer Certificate of Origin (DCO). When you submit a pull request, a DCO-bot will automatically determine | ||
whether you need to provide signoff for your commit. Please follow the instructions provided by DCO-bot, as pull | ||
requests cannot be merged until the author(s) have provided signoff to fulfill the DCO requirement. | ||
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-signing-your-work). | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need | ||
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the | ||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA. | ||
## Issues | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
This section describes the guidelines for submitting issues | ||
|
||
### Issue Types | ||
|
||
There are 2 types of issues: | ||
|
||
- Bug: You've found a bug with the code, and want to report it, or create an issue to track the bug. | ||
- Proposal: Used for items that propose a new idea or functionality. This allows feedback from others before code is written. | ||
|
||
## Contributing to Dapr | ||
|
||
This section describes the guidelines for contributing code / docs to Dapr. | ||
|
||
### Pull Requests | ||
|
||
All contributions come through pull requests. To submit a proposed change, we recommend following this workflow: | ||
|
||
1. Make sure there's an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make. | ||
2. Fork the relevant repo and create a new branch | ||
3. Create your change | ||
- Code changes require tests | ||
- Make sure to run the linters to check and format the code | ||
4. Update relevant documentation for the change | ||
5. Commit with [DCO sign-off](#developer-certificate-of-origin-signing-your-work) and open a PR | ||
6. Wait for the CI process to finish and make sure all checks are green | ||
7. A maintainer of the project will be assigned, and you can expect a review within a few days | ||
|
||
#### Use work-in-progress PRs for early feedback | ||
|
||
A good way to communicate before investing too much time is to create a "Work-in-progress" PR and share it with your reviewers. The standard way of doing this is to add a "[WIP]" prefix in your PR's title and open the pull request as a draft. | ||
### Developer Certificate of Origin: Signing your work | ||
|
||
#### Every commit needs to be signed | ||
|
||
The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the [DCO](https://developercertificate.org/), reformatted for readability: | ||
``` | ||
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. | ||
``` | ||
|
||
Contributors sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages. | ||
|
||
```text | ||
This is my commit message | ||
Signed-off-by: Random J Developer <[email protected]> | ||
``` | ||
|
||
Git even has a `-s` command line option to append this automatically to your commit message: | ||
|
||
```sh | ||
git commit -s -m 'This is my commit message' | ||
``` | ||
|
||
Each Pull Request is checked whether or not commits in a Pull Request do contain a valid Signed-off-by line. | ||
|
||
#### I didn't sign my commit, now what?! | ||
|
||
No worries - You can easily replay your changes, sign them and force push them! | ||
|
||
```sh | ||
git checkout <branch-name> | ||
git commit --amend --no-edit --signoff | ||
git push --force-with-lease <remote-name> <branch-name> | ||
``` |