Skip to content

Update references to current branch #3143

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
Dec 8, 2013
Merged

Update references to current branch #3143

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5753411
Update references to current branch
garak Nov 1, 2013
ef5c368
Update overview.rst
garak Nov 2, 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
20 changes: 10 additions & 10 deletions contributing/documentation/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before contributing, you need to become familiar with the :doc:`markup
language <format>` used by the documentation.

The Symfony2 documentation is hosted on GitHub:

2
Copy link
Member

Choose a reason for hiding this comment

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

this doesn't seem to be correct

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What?

Copy link
Member

Choose a reason for hiding this comment

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

you just added a random 2, didn't you?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right. I didn't find a way to amend a commit made on github. Maybe it's better to close this PR and make a new one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Forget it, just found a way and edited my commit. Thank you!

.. code-block:: text

https://github.com/symfony/symfony-docs
Expand All @@ -29,17 +29,17 @@ Consistent with Symfony's source code, the documentation repository is split int
multiple branches, 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 was introduced *after* Symfony 2.2
(e.g. in Symfony 2.3), your changes should always be based on the 2.2 branch.
To do this checkout the 2.2 branch before the next step:
Unless you're documenting a feature that was introduced *after* Symfony 2.3
(e.g. in Symfony 2.4), your changes should always be based on the 2.3 branch.
To do this checkout the 2.3 branch before the next step:

.. code-block:: bash

$ git checkout 2.2
$ git checkout 2.3

.. tip::

Your base branch (e.g. 2.2) will become the "Applies to" in the :ref:`doc-contributing-pr-format`
Your base branch (e.g. 2.3) 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):
Expand All @@ -57,17 +57,17 @@ Creating a Pull Request
Following the example, the pull request will default to be between your
``improving_foo_and_bar`` branch and the ``symfony-docs`` ``master`` branch.

If you have made your changes based on the 2.2 branch then you need to change
the base branch to be 2.2 on the preview page by clicking the ``edit`` button
If you have made your changes based on the 2.3 branch then you need to change
the base branch to be 2.3 on the preview page by clicking the ``edit`` button
on the top left:

.. image:: /images/docs-pull-request-change-base.png
:align: center

.. note::

All changes made to a branch (e.g. 2.2) will be merged up to each "newer"
branch (e.g. 2.3, master, etc) for the next release on a weekly basis.
All changes made to a branch (e.g. 2.3) will be merged up to each "newer"
branch (e.g. 2.4, master, etc) for the next release on a weekly basis.

GitHub covers the topic of `pull requests`_ in detail.

Expand Down