Contribution guide
==================

This document outlines how to contribute to this project. It details
instructions on how to submit issues, bug reports and patches.

Before you participate in the community, you should agree to respect
the :doc:`code`.

.. _project: https://gitlab.com/anarcat/undertime/
.. _merge requests: https://gitlab.com/anarcat/undertime/merge_requests
.. _tag: https://gitlab.com/anarcat/undertime/tags
.. _issues: https://gitlab.com/anarcat/undertime/issues
.. _edited online: https://gitlab.com/anarcat/undertime/edit/master/README.rst

Positive feedback
-----------------

Even if you have no changes, suggestions, documentation or bug reports
to submit, even just positive feedback like "it works" goes a long
way. It shows the project is being used and gives instant
gratification to contributors. So we welcome emails that tell us of
your positive experiences with the project or just thank you
notes. Head out to :ref:`contact` for contact informations or submit
a closed issue with your story.

You can also send your "thanks" through `saythanks.io
<https://saythanks.io/to/anarcat>`_.

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg 
   :alt: Say thanks to the author
   :target: https://saythanks.io/to/anarcat

Documentation
-------------

We love documentation!

The documentation resides in various `Sphinx
<https://www.sphinx-doc.org/>`_ documentations and in the README
file. Those can be `edited online`_ once you register and changes
are welcome through the normal patch and merge request system.

Issues found in the documentation are also welcome, see below to file
issues in our tracker.

Issues and bug reports
----------------------

We want you to report issues you find in the software. It is a
recognized and important part of contributing to this project. All
issues will be read and replied to politely and
professionnally. Issues and bug reports should be filed on the `issue
tracker <issues_>`_.

Please include which version number of undertime you are working
with. This can be determined using this magic command::

  undertime --version ||
  dpkg -l undertime ||
  ( pip3 show undertime || pip show undertime ) | grep Version

The above is because the ``--version`` flag was removed in version
1.1.0 and re-added in version 2.3.0, so there's a long period of time
during which it wasn't sufficient to tell the currently running
version.

Issue triage
~~~~~~~~~~~~

Issue triage is a useful contribution as well. You can review the
`issues`_ in the `project page <project_>`_ and, for each issue:

-  try to reproduce the issue, if it is not reproducible, label it with
   ``more-info`` and explain the steps taken to reproduce
-  if information is missing, label it with ``more-info`` and request
   specific information
-  if the feature request is not within the scope of the project or
   should be refused for other reasons, use the ``wontfix`` label and
   close the issue
-  mark feature requests with the ``enhancement`` label, bugs with
   ``bug``, duplicates with ``duplicate`` and so on...

Note that some of those operations are available only to project
maintainers, see below for the different statuses.

Security issues
~~~~~~~~~~~~~~~

Security issues should first be disclosed privately to the project
maintainers (see :doc:`contact`), which support receiving encrypted
emails through the usual OpenPGP key discovery mechanisms.

This project cannot currently afford bounties for security issues. We
would still ask that you coordinate disclosure, giving the project a
reasonable delay to produce a fix and prepare a release before public
disclosure.

Public recognition will be given to reporters security issues if
desired. We otherwise agree with the `Disclosure Guidelines`_ of the
`HackerOne project`_, at the time of writing.

.. _Disclosure Guidelines: https://www.hackerone.com/disclosure-guidelines
.. _HackerOne project: https://www.hackerone.com/

Patches
-------

Patches can be submitted through `merge requests`_ on the `project
page <project_>`_.

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 all
   target platforms.
-  A patch commit message must consist of a single short (less than 50
   characters) line stating 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.
-  Patches should be reviewed by at least one maintainer before being
   merged.

Project maintainers should merge their own patches only when they have
been approved by other maintainers, unless there is no response within a
reasonable timeframe (roughly one week) or there is an urgent change to
be done (e.g. security or data loss issue).

As an exception to this rule, this specific document cannot be changed
without the consensus of all administrators of the project.

    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
    this `discussion`_
    for more information.

.. _Collective Code Construct Contract: https://rfc.zeromq.org/spec:42/C4/
.. _discussion: https://github.com/zeromq/rfc/issues?utf8=%E2%9C%93&q=author%3Aanarcat%20

Patch triage
~~~~~~~~~~~~

You can also review existing pull requests, by cloning the contributor's
repository and testing it. If the tests do not pass (either locally or
in the online Continuous Integration (CI) system), if the patch is
incomplete or otherwise does not respect the above guidelines, submit a
review with "changes requested" with reasoning.

Membership
----------

There are three levels of membership in the project, Administrator (also
known as "Owner" in GitHub or GitLab), Maintainer (also known as
"Member" on GitHub or "Developer" on GitLab), or regular users (everyone
with or without an account). Anyone is welcome to contribute to the
project within the guidelines outlined in this document, regardless of
their status, and that includes regular users.

Maintainers can:

-  do everything regular users can
-  review, push and merge pull requests
-  edit and close issues

Administrators can:

-  do everything maintainers can
-  add new maintainers
-  promote maintainers to administrators

Regular users can be promoted to maintainers if they contribute to the
project, either by participating in issues, documentation or pull
requests.

Maintainers can be promoted to administrators when they have given
significant contributions for a sustained timeframe, by consensus of the
current administrators. This process should be open and decided as any
other issue.

Release process
---------------

0. before even considering a release, CI and the test suite should be
   green::

       tox

1. update the `debian/changelog`::

       dch -i
       
2. tag the release according to `Semantic Versioning`_ rules, include
   a release log (a nice digest of the commit log, not the whole
   thing)::

       git tag -s x.y.z

3. build and test the Python package::

       python3 setup.py bdist_wheel &&
       pip3 install $(ls -1tr dist/*.whl | tail -1) &&
       ~/.local/bin/undertime &&
       ~/.local/bin/undertime --selftest &&
       echo self-test suite passess in pip &&
       ~/.local/bin/undertime --version &&
       pip3 uninstall undertime

4. build and test the debian package::

       gbp buildpackage --git-export-dir=../build-area &&
       sudo dpkg -i $(ls -1tr ../build-area/undertime_*.deb | tail -1) &&
       undertime &&
       undertime --selftest &&
       echo self-test suite passess in Debian package &&
       undertime --version &&
       sudo dpkg --remove undertime

5. push changes::

       git push &&
       twine upload $(ls -1tr dist/*.whl | tail -1) &&
       debsign $(ls -1tr ../build-area/undertime_*_source.changes | tail -1) &&
       dput $(ls -1tr ../build-area/undertime_*_source.changes | tail -1)

 .. _Semantic Versioning: https://semver.org/
