Reshuffle docs again

This commit is contained in:
Markus Unterwaditzer 2016-03-04 14:57:38 +01:00
parent 07078fa06b
commit 325831049b
7 changed files with 80 additions and 71 deletions

View file

@ -1,13 +0,0 @@
===================
Support and Contact
===================
* The ``#vdirsyncer`` IRC channel on Freenode might be active, depending on
your timezone. Use it for support and general (including off-topic)
discussion.
* Open `a GitHub issue <https://github.com/untitaker/vdirsyncer/issues/>`_ for
concrete bug reports and feature requests.
* Lastly, you can also `contact the author directly
<https://unterwaditzer.net/contact.html>`_.

View file

@ -1,53 +1,3 @@
**Important:** Please read `CONTACT.rst <CONTACT.rst>`_ for questions and
support requests.
Reporting bugs
==============
* Make sure your problem isn't already listed in `Known Problems
<https://vdirsyncer.readthedocs.org/en/stable/problems.html>`_.
* Make sure you have the latest version by executing ``pip install --user
--upgrade vdirsyncer``.
* Use ``--verbosity=DEBUG`` when including output from vdirsyncer.
Suggesting features
===================
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. `Take a look at the documentation for software
working with vdirsyncer
<http://vdirsyncer.readthedocs.org/en/latest/supported.html>`_.
Submitting patches, pull requests
=================================
* **Discuss everything in the issue tracker first** (or contact me somehow
else) before implementing it.
* Make sure the tests pass. See below for running them.
* But not because you wrote too few tests.
* Add yourself to ``AUTHORS.rst``, and add a note to ``CHANGELOG.rst`` too.
Running tests, how to set up your development environment
=========================================================
For many patches, it might suffice to just let Travis run the tests. However,
Travis is slow, so you might want to run them locally too. For this, set up a
virtualenv_ and run this inside of it::
make install-test
make install-style
Then you can run::
make test
make style # Stylechecker
If you have any questions, feel free to open issues about it.
.. _virtualenv: http://virtualenv.readthedocs.org/
Please see `the documentation
<https://vdirsyncer.readthedocs.org/en/stable/contributing.html>`_ for how to
contribute to this project.

View file

@ -1,3 +1,5 @@
Before you submit bug reports: https://vdirsyncer.readthedocs.org/en/stable/contributing.html
Things to include in your bugreport:
* Your vdirsyncer version

View file

@ -29,10 +29,11 @@ Links of interest
<https://vdirsyncer.readthedocs.org/en/stable/tutorial.html>`_ for basic
usage.
* See `CONTACT.rst <CONTACT.rst>`_ for help and support.
* `Contact information
<https://vdirsyncer.readthedocs.org/en/stable/contact.html>`_
* See `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for how to contribute to this
project.
* `How to contribute to this project
<https://vdirsyncer.readthedocs.org/en/stable/contributing.html>`_
License
=======

View file

@ -1 +1,13 @@
.. include:: ../CONTACT.rst
===================
Support and Contact
===================
* The ``#vdirsyncer`` IRC channel on Freenode might be active, depending on
your timezone. Use it for support and general (including off-topic)
discussion.
* Open `a GitHub issue <https://github.com/untitaker/vdirsyncer/issues/>`_ for
concrete bug reports and feature requests.
* Lastly, you can also `contact the author directly
<https://unterwaditzer.net/contact.html>`_.

56
docs/contributing.rst Normal file
View file

@ -0,0 +1,56 @@
============================
Contributing to this project
============================
**Important:** Please read :doc:`contact` for questions and support requests.
Reporting bugs
==============
* Make sure your problem isn't already listed in `Known Problems
<https://vdirsyncer.readthedocs.org/en/stable/problems.html>`_.
* Make sure you have the latest version by executing ``pip install --user
--upgrade vdirsyncer``.
* Use ``--verbosity=DEBUG`` when including output from vdirsyncer.
Suggesting features
===================
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. `Take a look at the documentation for software
working with vdirsyncer
<http://vdirsyncer.readthedocs.org/en/latest/supported.html>`_.
Submitting patches, pull requests
=================================
* **Discuss everything in the issue tracker first** (or contact me somehow
else) before implementing it.
* Make sure the tests pass. See below for running them.
* But not because you wrote too few tests.
* Add yourself to ``AUTHORS.rst``, and add a note to ``CHANGELOG.rst`` too.
Running tests, how to set up your development environment
=========================================================
For many patches, it might suffice to just let Travis run the tests. However,
Travis is slow, so you might want to run them locally too. For this, set up a
virtualenv_ and run this inside of it::
make install-test
make install-style
Then you can run::
make test
make style # Stylechecker
If you have any questions, feel free to open issues about it.
.. _virtualenv: http://virtualenv.readthedocs.org/

View file

@ -28,6 +28,7 @@ Table of Contents
supported
problems
vdir
changelog
contributing
contact
changelog
license