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
================

First, to know a bit more about the version you are using, understand
that we adhere to `Semantic Versioning <http://semver.org/>`__, which is:

    Given a version number MAJOR.MINOR.PATCH, increment the:

    -  MAJOR version when you make incompatible API changes,
    -  MINOR version when you add functionality in a
       backwards-compatible manner, and
    -  PATCH version when you make backwards-compatible bug fixes.

    Additional labels for pre-release and build metadata are available
    as extensions to the MAJOR.MINOR.PATCH format.

The 2.0.x branch is featured in Debian Jessie and Ubuntu Xenial and is
therefore be maintained for security fixes for the lifetime of those
releases or of any other distribution that picks it up.

Most development and major bug fixes are done directly in the 2.x branch
and published as part of minor releases, which in turn become supported
branches.

Major, API-changing development will happen on the 3.x branch.

Those
`milestones <https://0xacab.org/monkeysphere/monkeysign/milestones>`__
are collaboratively tracked on `0xACAB <https://0xacab.org/monkeysphere/monkeysign/>`_.

Branches status
---------------

Each branch may be in one of those states:

* Development: the development branch is where most of the new
  features are implemented. Consequently, new features and changes may
  inadvertently break things.
* Supported: The branch is supported, but no further development will
  be made on the branch. Only critical issues and security fixes are
  performed.
* Deprecated: users are strongly encouraged to upgrade to later
  versions. No further updates perform except for critical
  security issues.
* Abandoned: the branch is completely abandoned. No further updates
  will ever be performed on the branch, security or otherwise.

====== =========== ====================================================================
Branch Status      Notes
====== =========== ====================================================================
0.x    Abandoned   explicitly unsupported.
1.x    Deprecated  supported until the release of Debian jessie, now only in Debian LTS
2.0.x  Supported   supported until the end of Debian jessie
2.1.x  Abandoned   short lived support branch, superseded by 2.2.x
2.2.x  Supported   supported until the end of Debian stretch
2.x    Development new releases performed here, schedule to be clarified
====== =========== ====================================================================

We try to keep the number of "supported" and "deprecated" branches to
two each, which means it is likely a "deprecated" branch gets
abandoned when a "supported" branch gets "deprecated".

If you are interested in supporting one of those branches beyond the
current state, we would be glad to welcome you on the
team. :doc:`Contact us <support>`!

See also :doc:`history` for more information on past releases.

Documentation
=============

We love documentation!

We maintain the documentation in the Git repository, in `RST`_
format. Documentation can be `edited directly on the website`_ and
built locally with `Sphinx`_ with::

  cd doc ; make html

The Sphinx project has a `good tutorial`_ on RST online. Documentation
is `automatically generated on RTD.io`_.
  
.. _RST: https://en.wikipedia.org/wiki/ReStructuredText
.. _edited directly on the website: https://0xacab.org/monkeysphere/monkeysign/tre                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            