Skip to content

Commit

Permalink
Close #6658: Add CODE_OF_CONDUCT (#6661)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
tk0miya authored and TimKam committed Oct 6, 2019
1 parent b474583 commit 7faeb79
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 0 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT
Original file line number Diff line number Diff line change
@@ -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.

6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
4 changes: 4 additions & 0 deletions doc/_templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,8 @@ <h2>{%trans%}Contributor Guide{%endtrans%}</h2>
<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 %}
8 changes: 8 additions & 0 deletions doc/code_of_conduct.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:tocdepth: 2

.. _code_of_conduct:

Sphinx Code of Conduct
======================

.. include:: ../CODE_OF_CONDUCT
1 change: 1 addition & 0 deletions doc/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Sphinx documentation contents
changes
examples
authors
code_of_conduct



Expand Down

0 comments on commit 7faeb79

Please sign in to comment.