From ee548cb10346c14dd2d671f3c0b6a6e9f86e38c3 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Thu, 7 Mar 2013 20:50:48 -0600 Subject: [PATCH 1/2] [2.0] Re-working some language in the contributing doc to work now that we have 2.0, 2.1, 2.2 and master --- contributing/documentation/overview.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index a449eafa1ad..94282d86c6d 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -26,13 +26,13 @@ then clone your fork: $ git clone git://github.com/YOURUSERNAME/symfony-docs.git Consistent with Symfony's source code, the documentation repository is split into -three branches: ``2.0`` for the current Symfony 2.0.x release, ``2.1`` for the -current Symfony 2.1.x release and ``master`` as the development branch for -upcoming releases. +multiple branches: ``2.0``, ``2.1``, ``2.2`` corresponding to the different +versions of Symfony itself. The ``master`` branch holds the documentation +for the development branch of the code. -Unless you're documenting a feature that's new to Symfony 2.1, your changes -should always be based on the 2.0 branch instead of the master branch. To do -this checkout the 2.0 branch before the next step: +Unless you're documenting a feature that was introduced *after* Symfony 2.0 +(e.g. in Symfony 2.1), your changes should always be based on the 2.0 branch. +To do this checkout the 2.0 branch before the next step: .. code-block:: bash From b9dbf816790d9d2ae83092f3aa7f4566c9827907 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Thu, 14 Mar 2013 20:56:02 -0500 Subject: [PATCH 2/2] [#2282] Adding some linking, thanks to @WouterJ --- contributing/documentation/overview.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index 94282d86c6d..f841c0fb84a 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -38,6 +38,11 @@ To do this checkout the 2.0 branch before the next step: $ git checkout 2.0 +.. tip:: + + Your base branch (e.g. 2.0) will become the "Applies to" in the :ref:`doc-contributing-pr-format` + that you'll use later. + Next, create a dedicated branch for your changes (for organization): .. code-block:: bash @@ -74,6 +79,8 @@ GitHub covers the topic of `pull requests`_ in detail. The Symfony2 documentation is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported :doc:`License `. +.. _doc-contributing-pr-format: + Pull Request Format ~~~~~~~~~~~~~~~~~~~