Add more information to CONTRIBUTING

This commit is contained in:
Markus Unterwaditzer 2014-04-15 18:00:03 +02:00
parent 0d3997b105
commit 2ea7799288

View file

@ -1,8 +1,15 @@
* If you're reporting an issue with vdirsyncer: You don't have to include
every detail about your environment, but include your configuration, the
commands you're executing (and their output). Also use ``--verbosity=DEBUG``
when including output from vdirsyncer.
* If you're reporting an issue with vdirsyncer:
* If you're suggesting a feature, keep in mind that vdirsyncer tries not to
be a calendar or contacts client, but rather just the piece of software that
syncronizes all the data.
* Make sure you have the latest version by executing ``pip install --user
--upgrade vdirsyncer``.
* Include 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 syncronizes all the data. If you're looking for a viewer for the
calendar data you've synced, `khal <https://github.com/geier/khal>`_ is what
you're looking for.