Skip to content

Commit 15f3c94

Browse files
committed
Added another bunch of fixes suggested by reviewers
1 parent ff66e94 commit 15f3c94

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

contributing/documentation/overview.rst

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Contributing to the Documentation
22
=================================
33

44
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
66
document new features and to maintain updated the rest of the documentation.
77

88
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
3434
book. In order to do those changes, follow these steps:
3535

3636
**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.
4039

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):
4443

4544
.. code-block:: bash
4645
@@ -115,7 +114,7 @@ In this example, this table would look as follows:
115114
| ------------- | ---
116115
| Doc fix? | yes
117116
| New docs? | no
118-
| Applies to | 2.3+
117+
| Applies to | all
119118
| Fixed tickets | #10575
120119
121120
**Step 9.** Now that you've successfully submitted your first contribution to the
@@ -132,14 +131,14 @@ changes and push them:
132131
$ cd projects/symfony-docs/
133132
$ git checkout improve_install_chapter
134133
135-
# do your changes ...
134+
# ... do your changes
136135
137136
$ git push
138137
139138
**Step 10.** After your pull request is eventually accepted and merged in the Symfony
140139
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`_.
143142

144143
Your Second Documentation Contribution
145144
--------------------------------------
@@ -177,7 +176,7 @@ Now you can proceed following the same steps explained in the previous section:
177176
$ git checkout 2.3
178177
$ git checkout -b my_changes
179178
180-
# do your changes ...
179+
# ... do your changes
181180
182181
# submit the changes to your forked repository
183182
$ git add xxx.rst # (optional) only if this is a new content
@@ -219,7 +218,7 @@ a **checklist**:
219218
$ git checkout 2.3
220219
$ git checkout -b my_changes
221220
222-
# do your changes ...
221+
# ... do your changes
223222
224223
# add and commit your changes
225224
$ git add xxx.rst # (optional) only if this is a new content
@@ -248,10 +247,9 @@ Frequently Asked Questions
248247
Why Do my Changes so Long to Be Reviewed and/or Merged?
249248
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
250249

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.
255253

256254
What If I Want to Translate Some Documentation into my Language?
257255
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -293,6 +291,7 @@ in the Symfony Documentation repository to ask the managers if they agree with
293291
your proposed changes. Otherwise, they could refuse your proposal after having
294292
made all the work and you would have wasted a lot of time.
295293

294+
.. _`github.com/symfony/symfony-docs`: https://github.com/symfony/symfony-docs
296295
.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html
297296
.. _`GitHub`: https://github.com/
298297
.. _`fork the repository`: https://help.github.com/articles/fork-a-repo

0 commit comments

Comments
 (0)