Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.07 KB

CONTRIBUTING.rst

File metadata and controls

28 lines (19 loc) · 1.07 KB
  • 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. If you're looking for a viewer for the calendar data you've synced, 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 and also add an entry to CHANGELOG.rst if you think your change is relevant to end users.