diff options
| author | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-08-14 19:36:01 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-08-14 19:36:01 (GMT) |
| commit | 7d0fc8100a0085772c3b2c331e5eb5771121081c (patch) | |
| tree | 52fc79c84a7ec3ded46ef74faeeea5fa78e3968c /docs/contributing.rst | |
| parent | 2d1942f76a52ea748617791bc22022fb447f182c (diff) | |
docs: Add a contributors guide
Mostly this is adopting policies (both DCO and Contributor Covenent)
that are commonly used by other projects...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..fd8bcdb --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,48 @@ +Contributor's Guide +=================== + +.. contents:: + :local: + :depth: 2 + +Introduction +------------ + +Anyone can contribute to the wasp-os project. Contributions are typically made +via github using the typical fork-and-pull-request approach. Contributors who +do not wish to use github are also welcome to share patches using +``git format-patch --to wasp-os@redfelineninja.org.uk`` and ``git send-email``. + +All contributions must include a ``Signed-off-by`` tag added by the contributor +who submits the patch or patches. The ``Signed-off-by`` tag is added at the end +of the patch description and certifies that the contributor either wrote the +patch or has the right to share the code under the open source license +appropriate for the file being modified. + +A ``Signed-off-by`` tag is an explicit statement that your contribution comes +under one of (a), (b), (c), or (d) from the list below so please be sure to +read carefully what you are certifying by adding your Signed-off-by. + +Additionally please be aware that that contributors, like all other members of +the wasp-os community, are expected to meet the community guidelines described +in the project's code of conduct when interacting within all community spaces +(including the wasp-os github presence). + +Developer Certificate of Origin +------------------------------- + +.. literalinclude:: dco.txt + :language: none + :emphasize-lines: 1-2,13 + +This procedure is the same one used by the Linux kernel project. To sign off a +patch append an appropriate line at the end of the commit message: + +.. code-block:: none + + Signed-off-by: Random Developer <r.developer@example.org> + +Please use your real name, anonymous and pseudonymous contributions will not be +accepted. + +.. include:: code_of_conduct.rst |
