diff --git a/CONTACT.rst b/CONTACT.rst deleted file mode 100644 index 5152003..0000000 --- a/CONTACT.rst +++ /dev/null @@ -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 `_ for - concrete bug reports and feature requests. - -* Lastly, you can also `contact the author directly - `_. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index df54b2a..a3c1f35 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,53 +1,3 @@ -**Important:** Please read `CONTACT.rst `_ for questions and -support requests. - -Reporting bugs -============== - -* Make sure your problem isn't already listed in `Known Problems - `_. - -* 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 -`_. - -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 +`_ for how to +contribute to this project. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index c142e47..3a5d2c7 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -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 diff --git a/README.rst b/README.rst index d598716..44fc254 100644 --- a/README.rst +++ b/README.rst @@ -29,10 +29,11 @@ Links of interest `_ for basic usage. -* See `CONTACT.rst `_ for help and support. +* `Contact information + `_ -* See `CONTRIBUTING.rst `_ for how to contribute to this - project. +* `How to contribute to this project + `_ License ======= diff --git a/docs/contact.rst b/docs/contact.rst index 7a2eff1..5152003 100644 --- a/docs/contact.rst +++ b/docs/contact.rst @@ -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 `_ for + concrete bug reports and feature requests. + +* Lastly, you can also `contact the author directly + `_. diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..dbdce49 --- /dev/null +++ b/docs/contributing.rst @@ -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 + `_. + +* 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 +`_. + +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/ diff --git a/docs/index.rst b/docs/index.rst index 1d42d4c..5f72d14 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,6 +28,7 @@ Table of Contents supported problems vdir - changelog + contributing contact + changelog license