Skip to content

Commit

Permalink
Merge branch '6.4' into 7.2
Browse files Browse the repository at this point in the history
* 6.4:
  Update overview.rst
  • Loading branch information
javiereguiluz committed Mar 6, 2025
2 parents 5a775a4 + a78ddb2 commit 5652ca5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,16 @@ memorable name for the new branch (if you are fixing a reported issue, use

.. code-block:: terminal
$ git checkout -b improve_install_article upstream/5.4
$ git checkout -b improve_install_article upstream/6.4
In this example, the name of the branch is ``improve_install_article`` and the
``upstream/5.4`` value tells Git to create this branch based on the ``5.4``
``upstream/6.4`` value tells Git to create this branch based on the ``6.4``
branch of the ``upstream`` remote, which is the original Symfony Docs repository.

Fixes should always be based on the **oldest maintained branch** which contains
the error. Nowadays this is the ``5.4`` branch. If you are instead documenting a
the error. Nowadays this is the ``6.4`` branch. If you are instead documenting a
new feature, switch to the first Symfony version that included it, e.g.
``upstream/6.2``.
``upstream/7.2``.

**Step 5.** Now make your changes in the documentation. Add, tweak, reword and
even remove any content and do your best to comply with the
Expand Down Expand Up @@ -156,7 +156,7 @@ changes should be applied:
:alt: The base branch select option on the GitHub page.

In this example, the **base fork** should be ``symfony/symfony-docs`` and
the **base** branch should be the ``5.4``, which is the branch that you selected
the **base** branch should be the ``4.4``, which is the branch that you selected
to base your changes on. The **head fork** should be your forked copy
of ``symfony-docs`` and the **compare** branch should be ``improve_install_article``,
which is the name of the branch you created and where you made your changes.
Expand Down Expand Up @@ -209,7 +209,7 @@ contribution to the Symfony docs:
# create a new branch based on the oldest maintained version
$ cd projects/symfony-docs/
$ git fetch upstream
$ git checkout -b my_changes upstream/5.4
$ git checkout -b my_changes upstream/6.4
# ... do your changes
Expand Down Expand Up @@ -258,8 +258,8 @@ into multiple branches, corresponding to the different versions of Symfony itsel
The latest (e.g. ``5.x``) branch holds the documentation for the development branch of
the code.

Unless you're documenting a feature that was introduced after Symfony 5.4,
your changes should always be based on the ``5.4`` branch. Documentation managers
Unless you're documenting a feature that was introduced after Symfony 6.4,
your changes should always be based on the ``6.4`` branch. Documentation managers
will use the necessary Git-magic to also apply your changes to all the active
branches of the documentation.

Expand Down

0 comments on commit 5652ca5

Please sign in to comment.