mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
* 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
This commit is contained in:
parent
b47458332a
commit
7faeb793e2
76
CODE_OF_CONDUCT
Normal file
76
CODE_OF_CONDUCT
Normal file
@ -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.
|
||||
|
@ -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
|
||||
=======
|
||||
|
||||
|
4
doc/_templates/index.html
vendored
4
doc/_templates/index.html
vendored
@ -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 %}
|
||||
|
8
doc/code_of_conduct.rst
Normal file
8
doc/code_of_conduct.rst
Normal file
@ -0,0 +1,8 @@
|
||||
:tocdepth: 2
|
||||
|
||||
.. _code_of_conduct:
|
||||
|
||||
Sphinx Code of Conduct
|
||||
======================
|
||||
|
||||
.. include:: ../CODE_OF_CONDUCT
|
@ -34,6 +34,7 @@ Sphinx documentation contents
|
||||
changes
|
||||
examples
|
||||
authors
|
||||
code_of_conduct
|
||||
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user