Skip to content

[2.0] Re-working contributing language for 2.2 branch #2282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 15, 2013
Merged

[2.0] Re-working contributing language for 2.2 branch #2282

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee548cb
[2.0] Re-working some language in the contributing doc to work now th…
weaverryan Mar 8, 2013
b9dbf81
[#2282] Adding some linking, thanks to @WouterJ
weaverryan Mar 15, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions contributing/documentation/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,23 @@ 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can use the PR format (the Applies to question) here, that means we connect some of the PR 'requirements' and that means people won't forget them (unless they didn't read this doc).


.. code-block:: bash

$ 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
Expand Down Expand Up @@ -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 <license>`.

.. _doc-contributing-pr-format:

Pull Request Format
~~~~~~~~~~~~~~~~~~~

Expand Down