Skip to content

Commit

Permalink
Merge pull request #4 from bartvm/stable_docs
Browse files Browse the repository at this point in the history
Add documentation about two branches
  • Loading branch information
rizar committed May 16, 2015
2 parents c0e7909 + 267e2ad commit 0635929
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 7 deletions.
24 changes: 18 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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?
===================
Expand All @@ -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
Expand Down
12 changes: 11 additions & 1 deletion docs/development/pull_request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
----------------------
Expand Down

0 comments on commit 0635929

Please sign in to comment.