@@ -2,7 +2,7 @@ Contributing to the Documentation
2
2
=================================
3
3
4
4
One of the essential principles of the Symfony project is that **documentation is
5
- as important as code **. That's why we dedicate a great amount of resources to
5
+ as important as code **. That's why a great amount of resources are dedicated to
6
6
document new features and to maintain updated the rest of the documentation.
7
7
8
8
More than 800 developers all around the world have contributed to Symfony
@@ -34,13 +34,12 @@ Let's imagine that you want to improve the installation chapter of the Symfony
34
34
book. In order to do those changes, follow these steps:
35
35
36
36
**Step 1. ** Go to the official Symfony documentation repository located at
37
- `github.com/symfony/symfony-docs <https://github.com/symfony/symfony-docs >`_
38
- and `fork the repository `_ to your personal account. This is only needed the
39
- first time you contribute to Symfony.
37
+ `github.com/symfony/symfony-docs `_ and `fork the repository `_ to your personal
38
+ account. This is only needed the first time you contribute to Symfony.
40
39
41
- **Step 2. ** **Clone ** the forked repository to your local machine (in this
42
- example we'll use the ``projects/symfony-docs/ `` directory to store the
43
- documentation; change this value accordingly):
40
+ **Step 2. ** **Clone ** the forked repository to your local machine (this
41
+ example uses the ``projects/symfony-docs/ `` directory to store the documentation;
42
+ change this value accordingly):
44
43
45
44
.. code-block :: bash
46
45
@@ -115,7 +114,7 @@ In this example, this table would look as follows:
115
114
| ------------- | ---
116
115
| Doc fix? | yes
117
116
| New docs? | no
118
- | Applies to | 2.3+
117
+ | Applies to | all
119
118
| Fixed tickets | #10575
120
119
121
120
**Step 9. ** Now that you've successfully submitted your first contribution to the
@@ -132,14 +131,14 @@ changes and push them:
132
131
$ cd projects/symfony-docs/
133
132
$ git checkout improve_install_chapter
134
133
135
- # do your changes ...
134
+ # ... do your changes
136
135
137
136
$ git push
138
137
139
138
**Step 10. ** After your pull request is eventually accepted and merged in the Symfony
140
139
documentation, you will be included in the `Symfony Documentation Contributors `_
141
- list. Moreover, if you happen to have a `SensioLabsConnect `_ profile, we will
142
- award you a cool `Symfony Documentation Badge `_.
140
+ list. Moreover, if you happen to have a `SensioLabsConnect `_ profile, you will
141
+ get a cool `Symfony Documentation Badge `_.
143
142
144
143
Your Second Documentation Contribution
145
144
--------------------------------------
@@ -177,7 +176,7 @@ Now you can proceed following the same steps explained in the previous section:
177
176
$ git checkout 2.3
178
177
$ git checkout -b my_changes
179
178
180
- # do your changes ...
179
+ # ... do your changes
181
180
182
181
# submit the changes to your forked repository
183
182
$ git add xxx.rst # (optional) only if this is a new content
@@ -219,7 +218,7 @@ a **checklist**:
219
218
$ git checkout 2.3
220
219
$ git checkout -b my_changes
221
220
222
- # do your changes ...
221
+ # ... do your changes
223
222
224
223
# add and commit your changes
225
224
$ git add xxx.rst # (optional) only if this is a new content
@@ -248,10 +247,9 @@ Frequently Asked Questions
248
247
Why Do my Changes so Long to Be Reviewed and/or Merged?
249
248
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
250
249
251
- Please be patient. It can take from 15 minutes to several days before your pull
252
- request can be fully reviewed. And after merging the changes, it could take again
253
- from some minutes to several hours before your changes appear on the symfony.com
254
- website.
250
+ Please be patient. It can take up to several days before your pull request can
251
+ be fully reviewed. After merging the changes, it could take again several hours
252
+ before your changes appear on the symfony.com website.
255
253
256
254
What If I Want to Translate Some Documentation into my Language?
257
255
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -293,6 +291,7 @@ in the Symfony Documentation repository to ask the managers if they agree with
293
291
your proposed changes. Otherwise, they could refuse your proposal after having
294
292
made all the work and you would have wasted a lot of time.
295
293
294
+ .. _`github.com/symfony/symfony-docs` : https://github.com/symfony/symfony-docs
296
295
.. _`reStructuredText` : http://docutils.sourceforge.net/rst.html
297
296
.. _`GitHub` : https://github.com/
298
297
.. _`fork the repository` : https://help.github.com/articles/fork-a-repo
0 commit comments