From 267e2ad407e3ec496082780290f8e2abdfffc1b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=20van=20Merri=C3=ABnboer?= Date: Sat, 16 May 2015 14:24:08 -0400 Subject: [PATCH] Add documentation about two branches --- CONTRIBUTING.rst | 24 ++++++++++++++++++------ docs/development/pull_request.rst | 12 +++++++++++- 2 files changed, 29 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f0b6ec5f..aa342e5d 100644 --- a/CONTRIBUTING.rst +++ b/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 diff --git a/docs/development/pull_request.rst b/docs/development/pull_request.rst index cd3d0ccb..8a1201d6 100644 --- a/docs/development/pull_request.rst +++ b/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 ----------------------