Skip to content

Commit b4ab1c1

Browse files
authored
add dco section in contribution overview page (#266)
1 parent 9a4e7db commit b4ab1c1

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/contribute/overview.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,39 @@ To help new contributors understand WasmEdge development workflow, this guide wi
2020
- [WasmEdge release process](release.md)
2121
- [Join WasmEdge community](community.md)
2222

23+
## Contribution Flow
24+
25+
To contribute to WasmEdge
26+
27+
### Signing-off on Commits (Developer Certificate of Origin)
28+
29+
To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.
30+
31+
See the [DCO](https://developercertificate.org) file for the full text of what you must agree to and how it works [here](https://github.com/probot/dco#how-it-works). To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:
32+
33+
```text
34+
Signed-off-by: John Doe <[email protected]>
35+
```
36+
37+
In most cases, you can add this signoff to your commit automatically with the `-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
38+
39+
```bash
40+
git commit -s -m “my commit message w/signoff”
41+
```
42+
43+
To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`:
44+
45+
```text
46+
[alias]
47+
amend = commit -s --amend
48+
cm = commit -s -m
49+
commit = commit -s
50+
```
51+
52+
Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
53+
54+
![VSCode sign-off](https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png)
55+
2356
## Ideas for contributions
2457

2558
If you're looking for something to contribute, we have issues

0 commit comments

Comments
 (0)