summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-08-14 19:36:01 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-08-14 19:36:01 (GMT)
commit7d0fc8100a0085772c3b2c331e5eb5771121081c (patch)
tree52fc79c84a7ec3ded46ef74faeeea5fa78e3968c
parent2d1942f76a52ea748617791bc22022fb447f182c (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>
-rw-r--r--docs/code_of_conduct.rst144
-rw-r--r--docs/contributing.rst48
-rw-r--r--docs/dco.txt37
-rw-r--r--docs/index.rst1
4 files changed, 230 insertions, 0 deletions
diff --git a/docs/code_of_conduct.rst b/docs/code_of_conduct.rst
new file mode 100644
index 0000000..4071ffb
--- /dev/null
+++ b/docs/code_of_conduct.rst
@@ -0,0 +1,144 @@
+Code of Conduct
+---------------
+
+Our Pledge
+~~~~~~~~~~
+
+We as members, contributors, and leaders pledge to make participation in
+our community a harassment-free experience for everyone, regardless of
+age, body size, visible or invisible disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open,
+welcoming, diverse, inclusive, and healthy community.
+
+Our Standards
+~~~~~~~~~~~~~
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our
+ mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political
+ attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email
+ address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+Enforcement Responsibilities
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Community leaders are responsible for clarifying and enforcing our
+standards of acceptable behavior and will take appropriate and fair
+corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, and will
+communicate reasons for moderation decisions when appropriate.
+
+Scope
+~~~~~
+
+This Code of Conduct applies within all community spaces, and also
+applies when an individual is officially representing the community in
+public spaces. Examples of representing our community include using an
+official e-mail address, posting via an official social media account,
+or acting as an appointed representative at an online or offline event.
+
+Enforcement
+~~~~~~~~~~~
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported to the community leaders responsible for enforcement at
+wasp-os@redfelineninja.org.uk . All complaints will be reviewed and
+investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security
+of the reporter of any incident.
+
+Enforcement Guidelines
+~~~~~~~~~~~~~~~~~~~~~~
+
+Community leaders will follow these Community Impact Guidelines in
+determining the consequences for any action they deem in violation of
+this Code of Conduct:
+
+1. Correction
+.............
+
+**Community Impact**: Use of inappropriate language or other behavior
+deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders,
+providing clarity around the nature of the violation and an explanation
+of why the behavior was inappropriate. A public apology may be
+requested.
+
+2. Warning
+..........
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, for a specified period of
+time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a
+temporary or permanent ban.
+
+3. Temporary Ban
+................
+
+**Community Impact**: A serious violation of community standards,
+including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No
+public or private interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, is
+allowed during this period. Violating these terms may lead to a
+permanent ban.
+
+4. Permanent Ban
+................
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of
+individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction
+within the community.
+
+Attribution
+~~~~~~~~~~~
+
+This Code of Conduct is adapted from the `Contributor
+Covenant <https://www.contributor-covenant.org>`__, version 2.0,
+available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by `Mozilla’s code of conduct
+enforcement ladder <https://github.com/mozilla/diversity>`__.
+
+For answers to common questions about this code of conduct, see the FAQ
+at https://www.contributor-covenant.org/faq. Translations are available
+at https://www.contributor-covenant.org/translations.
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
diff --git a/docs/dco.txt b/docs/dco.txt
new file mode 100644
index 0000000..8201f99
--- /dev/null
+++ b/docs/dco.txt
@@ -0,0 +1,37 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+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.
diff --git a/docs/index.rst b/docs/index.rst
index 9d4810a..8f38273 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,7 @@ Welcome to WASP-OS's documentation!
install
appguide
wasp
+ contributing
TODO
license