Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 2.28 KB

File metadata and controls

57 lines (37 loc) · 2.28 KB

Contributing guidelines for AgenDAV

Great to have you here. Here are a few ways you can help make this project better!

Mailing list

You are encouraged to use the following mailing list to ask anything before contributing code:

http://groups.google.com/group/agendav-dev

Perhaps something is already implemented or some code is going to be completely wiped, so a patch for it is not worth the effort. Feel free to subscribe, it is a really low traffic list. Don't be afraid to ask!

Contributing code

There are some facts that will help you when contributing code to AgenDAV:

Pull requests

  • Please, ask on agendav-dev list (see above) before sending a new PR
  • Pull requests should only affect the develop branch. PRs that affect the master branch will be discarded. If you think your PR could also be useful for latest stable (master branch) just comment it on the PR description
  • AgenDAV code follows PSR-1 and PSR-2
  • Make your pull requests as small as possible. One pull request, one feature
  • Make sure to add tests for your feature, and update the documentation if needed

Issues

When reporting a bug make sure you specify the following data:

  • Your AgenDAV version
  • What CalDAV server you are using
  • A brief description of the issue
  • Step by step guide of what you did. Screenshots are welcome
  • What you were expecting to happen and what actualy happened
  • Any logs that could help

It would be great if you could also try to reproduce the bug on latest HEAD.

Translation

AgenDAV uses Transifex for translations.

Have a look at Transifex documentation for more information about adding a new language or upadting an existing translation.

Documentation

Documentation is automatically generated and placed on http://docs.agendav.org/ . Updating the documentation requires some Sphinx knowledge.

Have a look at the doc/ directory.