8000 Merge branch '4.1' into 4.2 · symfony/symfony-docs@ed92cd2 · GitHub
[go: up one dir, main page]
Skip to content

Commit ed92cd2

Browse files
javiereguiluzjaviereguiluz
committed
Merge branch '4.1' into 4.2
* 4.1: Switch to 3.4 as oldest maintained branch Minor tweaks Changing the wording around module.exports FIX: Clarify best_practices/creating-the-project.rst
2 parents 79415b8 + 5db7555 commit ed92cd2

File tree

5 files changed

+25
-23
lines changed

5 files changed

+25
-23
lines changed

‎README.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Contributing
77
------------
88

99
>**Note**
10-
>Unless you're documenting a feature that was introduced *after* Symfony 2.8
11-
>(e.g. in Symfony 3.4), all pull requests must be based off of the **2.8** branch,
10+
>Unless you're documenting a feature that was introduced *after* Symfony 3.4
11+
>(e.g. in Symfony 4.2), all pull requests must be based off of the **3.4** branch,
1212
>**not** the master or older branches.
1313
1414
We love contributors! For more information on how you can contribute to the

‎best_practices/creating-the-project.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ Structuring the Application
4848
---------------------------
4949

5050
After creating the application, enter the ``blog/`` directory and you'll see a
51-
number of files and directories generated automatically:
51+
number of files and directories generated automatically. These are the most
52+
important ones:
5253

5354
.. code-block:: text
5455

‎contributing/code/patches.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Choose the right Branch
106106
Before working on a patch, you must determine on which branch you need to
107107
work:
108108

109-
* ``2.8``, if you are fixing a bug for an existing feature or want to make a
109+
* ``3.4``, if you are fixing a bug for an existing feature or want to make a
110110
change that falls into the :doc:`list of acceptable changes in patch versions
111111
</contributing/code/maintenance>` (you may have to choose a higher branch if
112112
the feature you are fixing was introduced in a later version);
@@ -117,7 +117,7 @@ work:
117117

118118
All bug fixes merged into maintenance branches are also merged into more
119119
recent branches on a regular basis. For instance, if you submit a patch
120-
for the ``2.8`` branch, the patch will also be applied by the core team on
120+
for the ``3.4`` branch, the patch will also be applied by the core team on
121121
the ``master`` branch.
122122

123123
Create a Topic Branch
@@ -130,18 +130,18 @@ topic branch:
130130
131131
$ git checkout -b BRANCH_NAME master
132132
133-
Or, if you want to provide a bugfix for the ``2.8`` branch, first track the remote
134-
``2.8`` branch locally:
133+
Or, if you want to provide a bugfix for the ``3.4`` branch, first track the remote
134+
``3.4`` branch locally:
135135

136136
.. code-block:: terminal
137137
138-
$ git checkout -t origin/2.8
138+
$ git checkout -t origin/3.4
139139
140-
Then create a new branch off the ``2.8`` branch to work on the bugfix:
140+
Then create a new branch off the ``3.4`` branch to work on the bugfix:
141141

142142
.. code-block:: terminal
143143
144-
$ git checkout -b BRANCH_NAME 2.8
144+
$ git checkout -b BRANCH_NAME 3.4
145145
146146
.. tip::
147147

@@ -245,7 +245,7 @@ while to finish your changes):
245245
246246
.. tip::
247247

248-
Replace ``master`` with the branch you selected previously (e.g. ``2.8``)
248+
Replace ``master`` with the branch you selected previously (e.g. ``3.4``)
249249
if you are working on a bugfix
250250

251251
When doing the ``rebase`` command, you might have to fix merge conflicts.
@@ -272,8 +272,8 @@ You can now make a pull request on the ``symfony/symfony`` GitHub repository.
272272

273273
.. tip::
274274

275-
Take care to point your pull request towards ``symfony:2.8`` if you want
276-
the core team to pull a bugfix based on the ``2.8`` branch.
275+
Take care to point your pull request towards ``symfony:3.4`` if you want
276+
the core team to pull a bugfix based on the ``3.4`` branch.
277277

278278
To ease the core team work, always include the modified components in your
279279
pull request message, like in:
@@ -344,7 +344,7 @@ Rework your Patch
344344

345345
Based on the feedback on the pull request, you might need to rework your
346346
patch. Before re-submitting the patch, rebase with ``upstream/master`` or
347-
``upstream/2.8``, don't merge; and force the push to the origin:
347+
``upstream/3.4``, don't merge; and force the push to the origin:
348348

349349
.. code-block:: terminal
350350

‎contributing/documentation/overview.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ memorable name for the new branch (if you are fixing a reported issue, use
112112

113113
.. code-block:: terminal
114114
115-
$ git checkout -b improve_install_article upstream/2.8
115+
$ git checkout -b improve_install_article upstream/3.4
116116
117117
In this example, the name of the branch is ``improve_install_article`` and the
118-
``upstream/2.8`` value tells Git to create this branch based on the ``2.8``
118+
``upstream/3.4`` value tells Git to create this branch based on the ``3.4``
119119
branch of the ``upstream`` remote, which is the original Symfony Docs repository.
120120

121121
Fixes should always be based on the **oldest maintained branch** which contains
122-
the error. Nowadays this is the ``2.8`` branch. If you are instead documenting a
122+
the error. Nowadays this is the ``3.4`` branch. If you are instead documenting a
123123
new feature, switch to the first Symfony version that included it, e.g.
124124
``upstream/3.1``. Not sure? That's ok! Just use the ``upstream/master`` branch.
125125

@@ -155,7 +155,7 @@ changes should be applied:
155155
:align: center
156156

157157
In this example, the **base fork** should be ``symfony/symfony-docs`` and
158-
the **base** branch should be the ``2.8``, which is the branch that you selected
158+
the **base** branch should be the ``3.4``, which is the branch that you selected
159159
to base your changes on. The **head fork** should be your forked copy
160160
of ``symfony-docs`` and the **compare** branch should be ``improve_install_article``,
161161
which is the name of the branch you created and where you made your changes.
@@ -205,7 +205,7 @@ contribution to the Symfony docs:
205205
# create a new branch based on the oldest maintained version
206206
$ cd projects/symfony-docs/
207207
$ git fetch upstream
208-
$ git checkout -b my_changes upstream/2.8
208+
$ git checkout -b my_changes upstream/3.4
209209
210210
# ... do your changes
211211
@@ -288,8 +288,8 @@ into multiple branches, corresponding to the different versions of Symfony itsel
288288
The ``master`` branch holds the documentation for the development branch of
289289
the code.
290290

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

‎frontend/encore/simple-example.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ The import and export Statements
180180
--------------------------------
181181

182182
Instead of using ``require`` and ``module.exports`` like shown above, JavaScript
183-
has an alternate syntax, which is a more accepted standard. Choose whichever you
184-
want: they do the same thing.
183+
provides an alternate syntax based on the `ECMAScript 6 modules`_ that includes
184+
the ability to use dynamic imports.
185185

186186
To export values using the alternate syntax, use ``exports``:
187187

@@ -345,3 +345,4 @@ Encore support many more features! For a full list of what you can do, see
345345
`Encore's index.js file`_. Or, go back to :ref:`list of Encore articles <encore-toc>`.
346346

347347
.. _`Encore's index.js file`: https://github.com/symfony/webpack-encore/blob/master/index.js
348+
.. _`ECMAScript 6 modules`: https://hacks.mozilla.org/2015/08/es6-in-depth-modules/

0 commit comments

Comments
 (0)
0