Merge pull request #641 from rizar/release-0.0.1

Release 0.0.1

.travis.yml

@@ -5,6 +5,7 @@ cache:
 branches:
   only:
     - master
+    - stable
 language: python
 python:
   - "2.7"

CONTRIBUTING.rst

@@ -1,10 +1,14 @@
-Questions about using Blocks?
-=============================
+Making a pull request
+=====================
 
-Please send your questions to the `Blocks users mailing list`_. You might not
-be the first one with this question or problem, so be sure to search both the
-mailing list and the GitHub issues to make sure the answer isn't out there
-already.
+Blocks development occurs in two separate branches: The ``master`` branch is the
+development branch. If you want to contribute a new feature or change the
+behavior of Blocks in any way, please make your pull request to this branch.
+
+The ``stable`` branch contains the latest release of Blocks. If you are fixing a
+bug (that is present in the latest release), make a pull request to this branch.
+If the bug is present in both the ``master`` and ``stable`` branch, two separate
+pull requests are in order.
 
 Want to contribute?
 ===================
@@ -31,6 +35,14 @@ Code guidelines
   If you're going to write a lot of code, have a read through our `coding
   guidelines`_.
 
+Questions about using Blocks?
+=============================
+
+Please send your questions to the `Blocks users mailing list`_. You might not
+be the first one with this question or problem, so be sure to search both the
+mailing list and the GitHub issues to make sure the answer isn't out there
+already.
+
 .. _Blocks users mailing list: https://groups.google.com/forum/#!forum/blocks-users
 .. _quick reference: https://blocks.readthedocs.org/en/latest/development/pull_request.html
 .. _the documentation: https://blocks.readthedocs.org/en/latest/development/index.html#formatting-guidelines

blocks/__init__.py

@@ -1,4 +1,4 @@
 """The blocks library for parametrized Theano ops."""
 # Scary warning: Adding code to this file can break namespace packages
 # See https://pythonhosted.org/setuptools/setuptools.html#namespace-packages
-__version__ = '0.1a1'
+__version__ = '0.0.1'

docs/conf.py

@@ -96,9 +96,9 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '0.0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/development/pull_request.rst

@@ -66,7 +66,7 @@ Running the command
 
 .. code-block:: bash
 
-    $ git remote -v |grep origin
+    $ git remote -v | grep origin
 
 should display two lines. The URLs therein should contain your GitHub username.
 
@@ -134,7 +134,17 @@ the content is. **If it is intended to resolve a specific ticket**, put "Fixes
 number. By doing this, GitHub will know to `automatically close the issue`_
 when your pull request is merged.
 
+Blocks development occurs in two separate branches: The ``master`` branch is the
+development branch. If you want to contribute a new feature or change the
+behavior of Blocks in any way, please make your pull request to this branch.
+
+The ``stable`` branch contains the latest release of Blocks. If you are fixing a
+bug (that is present in the latest release), make a pull request to this branch.
+If the bug is present in both the ``master`` and ``stable`` branch, two separate
+pull requests are in order. The command ``git-cherry-pick_`` could be useful here.
+
 .. _automatically close the issue: https://github.com/blog/1506-closing-issues-via-pull-requests
+.. _git-cherry-pick: https://git-scm.com/docs/git-cherry-pick
 
 Incorporating feedback
 ----------------------

docs/index.rst

@@ -11,7 +11,8 @@ Blocks is developed in parallel with Fuel_, a dataset processing framework.
 
 .. warning::
    Blocks is a new project which is still under development. As such, certain
-   (all) parts of the framework are subject to change.
+   (all) parts of the framework are subject to change. The last stable (and
+   thus likely an outdated) version can be found in the ``stable`` branch.
 
 .. tip::
 

docs/setup.rst

@@ -10,6 +10,14 @@ directly from GitHub.
    $ pip install git+git://github.com/mila-udem/blocks.git \
      -r https://raw.githubusercontent.com/mila-udem/blocks/master/requirements.txt
 
+This will give you the cutting-edge development version. The latest stable
+release is in the ``stable`` branch and can be installed as follows.
+
+.. code-block:: bash
+
+   $ pip install git+git://github.com/mila-udem/blocks.git@stable \
+     -r https://raw.githubusercontent.com/mila-udem/blocks/stable/requirements.txt
+
 .. note::
 
    Blocks relies on several packages, such as Theano_ and picklable_itertools_,