From bdee9478893936e4e51b12d2258ec6f585f8aa23 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Tue, 17 Mar 2015 21:24:32 +0100 Subject: [PATCH] docs: Fix review comments --- docs/conf.py | 2 +- docs/contributing.rst | 17 ++++++++++------- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 88ea49f0..22ecb6fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -84,7 +84,7 @@ def setup(app): # -- General configuration ---------------------------------------------------- -needs_sphinx = '1.0' +needs_sphinx = '1.3' extensions = [ 'sphinx.ext.autodoc', diff --git a/docs/contributing.rst b/docs/contributing.rst index ecfaea90..b5230b18 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -12,13 +12,14 @@ If you want to contribute to Mopidy, here are some tips to get you started. Asking questions ================ -Please use one of these channels for requesting help with Mopidy and its -extensions: +Please get in touch with us in one of these ways when requesting help with +Mopidy and its extensions: - Our discussion forum: `discuss.mopidy.com `_. Just sign in and fire away. -- Our IRC channel: ``#mopidy`` on `irc.freenode.net `_, +- Our IRC channel: `#mopidy `_ + on `irc.freenode.net `_, with public `searchable logs `_. Be prepared to hang around for a while, as we're not always around to answer straight away. @@ -80,11 +81,13 @@ Pull request guidelines bug fix. Keep branches small and on topic, as that makes them far easier to review. We often use the following naming convention for branches: - - Features get the prefix ``feature/`` + - Features get the prefix ``feature/``, e.g. + ``feature/track-last-modified-as-ms``. - - Bug fixes get the prefix ``fix/`` + - Bug fixes get the prefix ``fix/``, e.g. ``fix/902-consume-track-on-next``. - - Improvements to the documentation get the prefix ``docs/`` + - Improvements to the documentation get the prefix ``docs/``, e.g. + ``docs/add-ext-mopidy-spotify-tunigo``. #. Follow the :ref:`code style `, especially make sure the ``flake8`` linter does not complain about anything. Travis CI will check @@ -110,7 +113,7 @@ Pull request guidelines - Write in the imperative, present tense: "add" not "added". - For more inspiration, read these blog posts: + For more inspiration, feel free to read these blog posts: - `Writing Git commit messages `_