summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2019-10-06 23:41:37 +0900
committerTimotheus Kampik <timotheus.kampik@gmail.com>2019-10-06 16:41:37 +0200
commit7faeb793e2e16cde4e5759443fb7f84efddcd9ea (patch)
treef0dd1fabaee01d60a0d4b0cf9ea49e2fc848b852
parentb47458332a48c571f86bcb662efba70dbfd027c9 (diff)
downloadsphinx-git-7faeb793e2e16cde4e5759443fb7f84efddcd9ea.tar.gz
Close #6658: Add CODE_OF_CONDUCT (#6661)
* Close #6658: Add CODE_OF_CONDUCT * #6658 refine CoC * Base on Django CoC: https://www.djangoproject.com/conduct/ * Simplify: we are a smaller project and can be more concise * Add to ToC * Link from README * Link from index page
-rw-r--r--CODE_OF_CONDUCT76
-rw-r--r--README.rst6
-rw-r--r--doc/_templates/index.html4
-rw-r--r--doc/code_of_conduct.rst8
-rw-r--r--doc/contents.rst1
5 files changed, 95 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT b/CODE_OF_CONDUCT
new file mode 100644
index 000000000..f820bd131
--- /dev/null
+++ b/CODE_OF_CONDUCT
@@ -0,0 +1,76 @@
+Like the technical community as a whole, the Sphinx team and community is made
+up of volunteers from all over the world.
+Diversity is a strength, but it can also lead to communication issues and
+unhappiness. To that end, we have a few ground rules that we ask people to
+adhere to.
+
+* **Be friendly and patient.**
+
+* **Be welcoming.**
+ We strive to be a community that welcomes and supports people of all
+ backgrounds and identities. This includes, but is not limited to members of
+ any race, ethnicity, culture, national origin, colour, immigration status,
+ social and economic class, educational level, sex, sexual orientation, gender
+ identity and expression, age, size, family status, political belief, religion,
+ and mental and physical ability.
+
+* **Be considerate.**
+ Your work will be used by other people, and you in turn will depend on the
+ work of others. Any decision you take will affect users and colleagues, and
+ you should take those consequences into account when making decisions.
+ Remember that we're a world-wide community, so you might not be communicating
+ in someone else's primary language.
+
+* **Be respectful.**
+ Not all of us will agree all the time, but disagreement is no excuse for poor
+ behavior and poor manners. We might all experience some frustration now and
+ then, but we cannot allow that frustration to turn into a personal attack.
+ It’s important to remember that a community where people feel uncomfortable or
+ threatened is not a productive one. Members of the Sphinx community should be
+ respectful when dealing with other members as well as with people outside the
+ Sphinx community.
+
+* **Be careful in the words that you choose.**
+ We are a community of professionals, and we conduct ourselves professionally.
+ Be kind to others. Do not insult or put down other participants. Harassment
+ and other exclusionary behavior aren't acceptable. This includes, but is not
+ limited to:
+
+ * Violent threats or language directed against another person.
+
+ * Discriminatory jokes and language.
+
+ * Posting sexually explicit or violent material.
+
+ * Posting (or threatening to post) other people's personally identifying
+ information ("doxing").
+
+ * Personal insults, especially those using racist or sexist terms.
+
+ * Unwelcome sexual attention.
+
+ * Advocating for, or encouraging, any of the above behavior.
+
+ * Repeated harassment of others. In general, if someone asks you to stop, then
+ stop.
+
+* **When we disagree, try to understand why.**
+ Disagreements, both social and technical, happen all the time and Sphinx is no
+ exception. It is important that we resolve disagreements and differing views
+ constructively. Remember that we’re different. Different people have different
+ perspectives on issues. Being unable to understand why someone holds a
+ viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to
+ err and blaming each other doesn’t get us anywhere. Instead, focus on helping
+ to resolve issues and learning from mistakes.
+
+This isn’t an exhaustive list of things that you can’t do.
+Rather, take it in the spirit in which it’s intended - a guide to make it easier
+to enrich all of us and the technical communities in which we participate.
+This code of conduct applies to all spaces of the Sphinx community.
+
+Attribution
+-----------
+
+Original text courtesy of the Speak Up! project:
+http://web.archive.org/web/20141109123859/http://speakup.io/coc.html.
+
diff --git a/README.rst b/README.rst
index 5a566c300..7f0adb6cc 100644
--- a/README.rst
+++ b/README.rst
@@ -90,6 +90,12 @@ Get in touch
.. _on GitHub: https://github.com/sphinx-doc/sphinx
.. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
+Please adhere to our `code of conduct`__.
+
+__ http://www.sphinx-doc.org/en/master/code_of_conduct.html
+
+__
+
Testing
=======
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index c22eebbf9..1fc4ee51c 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -120,4 +120,8 @@
<li>{%trans path=pathto("authors")%}<a href="{{ path }}">Sphinx Authors</a></li>{%endtrans%}
</ul>
+ <h2>{%trans%}Code of Conduct{%endtrans%}</h2>
+
+ {%trans path=pathto("code_of_conduct")%}Please adhere to our <a href="{{ path }}">Code of Conduct</a>.{%endtrans%}
+
{% endblock %}
diff --git a/doc/code_of_conduct.rst b/doc/code_of_conduct.rst
new file mode 100644
index 000000000..c1af92ddc
--- /dev/null
+++ b/doc/code_of_conduct.rst
@@ -0,0 +1,8 @@
+:tocdepth: 2
+
+.. _code_of_conduct:
+
+Sphinx Code of Conduct
+======================
+
+.. include:: ../CODE_OF_CONDUCT
diff --git a/doc/contents.rst b/doc/contents.rst
index 91ce55917..7e87cfffa 100644
--- a/doc/contents.rst
+++ b/doc/contents.rst
@@ -34,6 +34,7 @@ Sphinx documentation contents
changes
examples
authors
+ code_of_conduct