From 2ea7799288f91da34e8d162b05d01da180da8752 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Tue, 15 Apr 2014 18:00:03 +0200 Subject: [PATCH] Add more information to CONTRIBUTING --- CONTRIBUTING.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6284d62..74e7b4d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 `_ is what + you're looking for.