Hello! We are running our annual fundraising. Please consider making a donation if you value this freely available service or want to support people around the world working towards liberatory social change. https://riseup.net/donate.

Commit 93f9ab53 authored by simonft's avatar simonft
Browse files

Merge branch 'codes' into '2.x'

code of conduct, patches guidelines and glossary

a few changes to the contributing documentation to adopt the code of conduct (#54), clarify patches guidelines and refer to the modernPGP website.

See merge request !18
parents 75bd1f1a edbdf227
......@@ -4,6 +4,126 @@ Contribute
This section explains the various ways users can participate in the
development of Monkeysign, or get support when they find problems.
.. _conduct:
Code of conduct
===============
Our Pledge
----------
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
Our Standards
-------------
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
Our Responsibilities
--------------------
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Scope
-----
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
Enforcement
-----------
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting one of the persons :ref:`listed below <conduct_contacts>` individually. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. Project maintainers are
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
Project maintainers are encouraged to follow the spirit of the `Django
Code of Conduct Enforcement Manual <enforcement_>`_ when receiving
reports.
.. _enforcement: https://www.djangoproject.com/conduct/enforcement-manual/
.. _conduct_contacts:
Contacts
--------
The following people have volunteered to be available to respond to
Code of Conduct reports. They have reviewed existing literature and
agree to follow the aforementioned process in good faith. They also
accept OpenPGP-encrypted email:
* Antoine Beaupré <anarcat@debian.org>
* Daniel Kahn Gillmor <dkg@fifthhorseman.net>
Attribution
-----------
This Code of Conduct is adapted from the `Contributor Covenant <homepage_>`_, version 1.4,
available at `http://contributor-covenant.org/version/1/4 <version_>`_.
.. _homepage: http://contributor-covenant.org
.. _version: http://contributor-covenant.org/version/1/4
Changes
-------
The Code of Conduct was modified to refer to *project maintainers*
instead of *project team* and small paragraph was added to refer to
the Django enforcement manual.
.. note:: We have so far determined that writing an explicit
enforcement policy is not necessary, considering the
available literature already available online and the
relatively small size of the Monkeysign community. This may
change in the future if the community grows larger.
This code of conduct was adopted in 2016 by the Monkeysign
maintainers, see :issue:`54` for more details about the
discussion.
.. _schedule:
Support schedule
......@@ -182,6 +302,31 @@ If you prefer old school, offline email systems, you can also use the
Debian BTS, as described above, or send patches to the mailing list for
discussion.
Some guidelines for patches:
* A patch should be a minimal and accurate answer to exactly one
identified and agreed problem.
* A patch must compile cleanly and pass project self-tests on at least
the principle target platform.
* A patch commit message must consist of a single short (less than 50
characters) line stating the a summary of the change, followed by a
blank line and then a description of the problem being solved and
its solution, or a reason for the change. Write more information,
not less, in the commit log.
Maintainers should not merge their own patches unless there is no
response from other maintainers within a reasonable time frame (1-2
days).
.. note:: Those guidelines were inspired by the `Collective Code
Construct Contract`_. The document was found to be a little
too complex and hard to read and wasn't adopted in its
entirety. See `those discussions
<https://github.com/zeromq/rfc/issues?utf8=%E2%9C%93&q=author%3Aanarcat%20>`_
for more information.
.. _Collective Code Construct Contract: https://rfc.zeromq.org/spec:42/C4/
Unit tests
==========
......
......@@ -31,3 +31,7 @@ In this documentation, the following definitions are used:
A computer program used to read, compose and send email,
normally ran on user computers. See :wikipedia:`Mail User
Agent` for more information.
We also try to adhere to the `Modern PGP <http://modernpgp.org/>`_
`terminology <https://github.com/ModernPGP/terminology>`_ when
possible.
......@@ -51,6 +51,8 @@ __documentation__ = 'http://monkeysign.readthedocs.io/en/' + __version__
# hack to include the credits in the documentation
# maybe this should be parsed from a AUTHORS file instead, see
# https://0xacab.org/monkeysphere/monkeysign/issues/56
# if you feel comptent to respond to Code of Conduct reports,
# make sure you add your email address below
# credits-start
__authors__ = ['In alphabetical order:',
'',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment