vdirsyncer/CONTRIBUTING.rst
2014-11-15 15:19:08 +01:00

29 lines
1.2 KiB
ReStructuredText

* If you're reporting an issue with vdirsyncer:
* Make sure you have the latest version by executing ``pip install --user
--upgrade vdirsyncer``.
* Include the Python version, your configuration, the commands you're
executing, and their output.
* Use ``--verbosity=DEBUG`` when including output from vdirsyncer.
* If you're suggesting a feature, keep in mind that vdirsyncer tries not to be
a full calendar or contacts client, but rather just the piece of software
that synchronizes all the data. `Take a look at the documentation for
software working with vdirsyncer
<http://vdirsyncer.readthedocs.org/en/latest/supported.html>`_.
* If you're submitting pull requests:
* If you thought of a new feature for vdirsyncer, don't just go on and
implement it, but **first discuss it in the issue tracker**, otherwise you
might have wasted your time if your idea gets rejected.
* Make sure your tests pass on Travis.
* But not because you wrote too few tests.
* Add yourself to ``AUTHORS.rst``. Don't add anything to
``CHANGELOG.rst``, I do that myself shortly before the release. You can
help by writing meaningful commit messages.