@@ -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:
@@ -167,6 +167,19 @@ Now you can **sync your fork** by executing the following command:
167
167
$ git checkout master
168
168
$ git merge upstream/master
169
169
170
+ .. note ::
171
+
172
+ If you are documenting a feature based on another branch than master,
173
+ you'll also have to sync that branch. For example, if your changes will
174
+ be based on the 2.3 branch, execute the following commands:
175
+
176
+ .. code-block :: bash
177
+
178
+ $ cd projects/symfony-docs/
179
+ $ git fetch upstream
180
+ $ git checkout 2.3
181
+ $ git merge upstream/2.3
182
+
170
183
Great! Now you can proceed by following the same steps explained in the previous
171
184
section:
172
185
0 commit comments