vdirsyncer/CONTRIBUTING.rst
Markus Unterwaditzer c1eb55c241 Copyright and contributor stuff
Fix #60
2014-05-22 12:50:43 +02:00

27 lines
997 B
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 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.
* If you're submitting pull requests:
* Make sure your tests pass on Travis.
* But not because you wrote too few tests.
* Write descriptive commit messages, mostly because i need to write a
changelog at some point. Use ``git rebase -i`` and ``git commit --ammend``
if needed.
* Add yourself to ``CONTRIBUTORS.rst``.