@@ -3,10 +3,10 @@ Contributing to the Documentation
3
3
4
4
One of the essential principles of the Symfony project is that **documentation is
5
5
as important as code **. That's why a great amount of resources are dedicated to
6
- documenting new features and to keeping the rest of the documentation up to date.
6
+ documenting new features and to keeping the rest of the documentation up-to- date.
7
7
8
- More than 800 developers all around the world have contributed to Symfony's
9
- documentation, and we are glad that you are considering joining this big family.
8
+ More than 700 developers all around the world have contributed to Symfony's
9
+ documentation and we are glad that you are considering joining this big family.
10
10
This guide will explain everything you need to contribute to the Symfony
11
11
documentation.
12
12
@@ -27,9 +27,9 @@ Before Your First Contribution
27
27
Your First Documentation Contribution
28
28
-------------------------------------
29
29
30
- In this section you'll learn how to contribute to the Symfony documentation for
30
+ In this section, you'll learn how to contribute to the Symfony documentation for
31
31
the first time. The next section will explain the shorter process you'll follow
32
- in the future for every contribution after your first.
32
+ in the future for every contribution after your first one .
33
33
34
34
Let's imagine that you want to improve the installation chapter of the Symfony
35
35
book. In order to make your changes, follow these steps:
@@ -164,8 +164,12 @@ Now you can **sync your fork** by executing the following command:
164
164
165
165
$ cd projects/symfony-docs/
166
166
$ git fetch upstream
167
- $ git checkout master
168
- $ git merge upstream/master
167
+ $ git checkout 2.3
168
+ $ git merge upstream/2.3
169
+
170
+ This command will update the ``2.3 `` branch, which is the one you used to
171
+ create the new branch for your changes. If have used another base branch,
172
+ e.g. ``master ``, replace the ``2.3 `` with the appropriate branch name.
169
173
170
174
Great! Now you can proceed by following the same steps explained in the previous
171
175
section:
@@ -212,8 +216,8 @@ steps to contribute to the Symfony documentation, which you can use as a
212
216
# sync your fork with the official Symfony repository
213
217
$ cd projects/symfony-docs/
214
218
$ git fetch upstream
215
- $ git checkout master
216
- $ git merge upstream/master
219
+ $ git checkout 2.3
220
+ $ git merge upstream/2.3
217
221
218
222
# create a new branch from the oldest maintained version
219
223
$ git checkout 2.3
@@ -262,10 +266,11 @@ Why Should I Use the Oldest Maintained Branch Instead of the Master Branch?
262
266
263
267
Consistent with Symfony's source code, the documentation repository is split
264
268
into multiple branches, corresponding to the different versions of Symfony itself.
265
- The master branch holds the documentation for the development branch of the code.
269
+ The ``master `` branch holds the documentation for the development branch of
270
+ the code.
266
271
267
272
Unless you're documenting a feature that was introduced after Symfony 2.3,
268
- your changes should always be based on the 2.3 branch. Documentation managers
273
+ your changes should always be based on the `` 2.3 `` branch. Documentation managers
269
274
will use the necessary Git-magic to also apply your changes to all the active
270
275
branches of the documentation.
271
276
0 commit comments