add contributing

buttahtoast · Jul 8, 2020 · fd302ce · fd302ce
1 parent ec96f16
commit fd302ce
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing Guidelines
+
+We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+
+## Sign off Your Work
+
+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](./DCO). Contributors must sign-off each commit by adding a Signed-off-by line to commit messages.
+
+This is my commit message
+
+```
+Signed-off-by: Random J Developer <random@developer.example.org>
+See git help commit:
+
+-s, --signoff
+    Add Signed-off-by line by the committer at the end of the commit log
+    message. The meaning of a signoff depends on the project, but it typically
+    certifies that committer has the rights to submit this work under the same
+    license and agrees to a Developer Certificate of Origin (see
+    http://developercertificate.org/ for more information).
+```
+
+# How to Contribute
+
+With these steps you can make a contribution:
+
+  1. Fork this repository, develop and test your changes on that fork.
+  2. All commits have a meaningful description and are signed off as described above.
+  3. Submit a pull request from your fork to this project.
+
+## 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/articles/about-pull-requests/) for more information on using pull requests. See the above stated requirements for PR on this project.