Skip to content

Commit 7ed8f00

Browse files
javiereguiluzdaFish
authored and
daFish
committed
Fixed all the errors found by Ryan
1 parent cc5ac25 commit 7ed8f00

File tree

2 files changed

+35
-33
lines changed

2 files changed

+35
-33
lines changed

contributing/documentation/format.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ If you want to modify that title, use this alternative syntax:
174174
:doc:`environments`
175175
176176
**Links to the API** follow a different syntax, where you must specify the type
177-
of linked resource (``namespace``, ``class`` or ``method``):
177+
of the linked resource (``namespace``, ``class`` or ``method``):
178178

179179
.. code-block:: rst
180180

contributing/documentation/overview.rst

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ Contributing to the Documentation
33

44
One of the essential principles of the Symfony project is that **documentation is
55
as important as code**. That's why a great amount of resources are dedicated to
6-
document new features and to maintain updated the rest of the documentation.
6+
documenting new features and to keeping the rest of the documentation up to date.
77

8-
More than 800 developers all around the world have contributed to Symfony
8+
More than 800 developers all around the world have contributed to Symfony's
99
documentation, and we are glad that you are considering joining this big family.
10-
This guide will explain everything you need to contribute to Symfony documentation.
10+
This guide will explain everything you need to contribute to the Symfony
11+
documentation.
1112

1213
Before Your First Contribution
1314
------------------------------
@@ -22,20 +23,20 @@ The Symfony documentation is hosted on GitHub:
2223
If you are not familiar with this format, read :doc:`this article </contributing/documentation/format>`
2324
for a quick overview of its basic features.
2425
* Symfony documentation is hosted on GitHub_. You'll need a GitHub user account
25-
to contribute documentation.
26+
to contribute to the documentation.
2627
* Symfony documentation is published under a
2728
:doc:`Creative Commons BY-SA 3.0 License </contributing/documentation/license>`
2829
and all your contributions will implicitly adhere to that license.
2930

3031
Your First Documentation Contribution
3132
-------------------------------------
3233

33-
In this section you'll learn how to contribute to Symfony documentation for the
34-
first time. Next section will explain the abbreviated process to follow for the
35-
next contributions.
34+
In this section you'll learn how to contribute to the Symfony documentation for
35+
the first time. The next section will explain the shorter process you'll follow
36+
in the future for every contribution after your first.
3637

3738
Let's imagine that you want to improve the installation chapter of the Symfony
38-
book. In order to do those changes, follow these steps:
39+
book. In order to make your changes, follow these steps:
3940

4041
**Step 1.** Go to the official Symfony documentation repository located at
4142
`github.com/symfony/symfony-docs`_ and `fork the repository`_ to your personal
@@ -58,7 +59,7 @@ Nowadays this is the ``2.3`` branch:
5859
$ cd symfony-docs/
5960
$ git checkout 2.3
6061
61-
If you were instead documenting a new feature, switch to the first Symfony
62+
If you are instead documenting a new feature, switch to the first Symfony
6263
version which included it: ``2.5``, ``2.6``, etc.
6364

6465
<<<<<<< HEAD
@@ -88,15 +89,15 @@ doc:`/contributing/documentation/standards`.
8889
>>>>>>> Revamped the documentation about "Contributing Docs"
8990

9091
$ git commit book/installation.rst
91-
$ git push
92+
$ git push origin improve_install_chapter
9293

9394
**Step 7.** Everything is now ready to initiate a **pull request**. Go to your
9495
forked repository at ``https//github.com/<YOUR GITHUB USERNAME>/symfony-docs``
95-
and click on the ``Pull Requests`` link located at the sidebar.
96+
and click on the ``Pull Requests`` link located in the sidebar.
9697

9798
Then, click on the big ``New pull request`` button. As GitHub cannot guess the
9899
exact changes that you want to propose, select the appropriate branches where
99-
changes should be applied:
100+
changes should be applied:º
100101

101102
.. image:: /images/docs-pull-request-change-base.png
102103
:align: center
@@ -105,10 +106,10 @@ In this example, the **base repository** should be ``symfony/symfony-docs`` and
105106
the **base branch** should be the ``2.3``, which is the branch that you selected
106107
to base your changes on. The **compare repository** should be your forked copy
107108
of ``symfony-docs`` and the **compare branch** should be ``improve_install_chapter``,
108-
which is the name that you selected to work on your changes.
109+
which is the name of the branch you created and where you made your changes.
109110

110111
**Step 8.** The last step is to prepare the **description** of the pull request.
111-
To ensure that your work is reviewed quickly, you have to add the following table
112+
To ensure that your work is reviewed quickly, please add the following table
112113
at the beginning of your pull request description:
113114

114115
.. code-block:: text
@@ -137,7 +138,7 @@ carefully review your work in short time and they will let you know about any
137138
required change.
138139

139140
In case you need to add or modify anything, there is no need to create a new
140-
pull request. Just make sure that you are in the correct branch, make your
141+
pull request. Just make sure that you are on the correct branch, make your
141142
changes and push them:
142143

143144
.. code-block:: bash
@@ -167,18 +168,17 @@ The first contribution took some time because you had to fork the repository,
167168
learn how to write documentation, comply with the pull requests standards, etc.
168169
The second contribution will be much easier, except for one detail: given the
169170
furious update activity of the Symfony documentation repository, odds are that
170-
your fork is now outdated comparing it with the official repository.
171+
your fork is now out of date with the official repository.
171172

172-
Solving this problem requires to `sync your fork`_ with the original repository.
173-
To do so, execute first this command to tell git which is the original repository
174-
from which you created the fork:
173+
Solving this problem requires you to `sync your fork`_ with the original repository.
174+
To do this, execute this command first to tell git about the original repository:
175175

176176
.. code-block:: bash
177177
178178
$ cd projects/symfony-docs/
179179
$ git remote add upstream https://github.com/symfony/symfony-docs.git
180180
181-
Now you can **sync your fork** executing the following command:
181+
Now you can **sync your fork** by executing the following command:
182182

183183
.. code-block:: bash
184184
@@ -196,7 +196,8 @@ tags would be removed from the new 2.5 branch.
196196
$ git merge upstream/master
197197
>>>>>>> Revamped the documentation about "Contributing Docs"
198198

199-
Now you can proceed following the same steps explained in the previous section:
199+
Great! Now you can proceed by following the same steps explained in the previous
200+
section:
200201

201202
.. code-block:: bash
202203
@@ -222,18 +223,18 @@ Now you can proceed following the same steps explained in the previous section:
222223
# | Applies to | [Symfony version numbers this applies to]
223224
# | Fixed tickets | [comma separated list of tickets fixed by the PR]
224225
225-
Your second contribution is now completed, so **go and celebrate again!**
226-
You will also see how your ranking improves in the list of
226+
Your second contribution is now complete, so **go and celebrate again!**
227+
You can also see how your ranking improves in the list of
227228
`Symfony Documentation Contributors`_.
228229

229230
Your Next Documentation Contributions
230231
-------------------------------------
231232

232233
Now that you've made two contributions to the Symfony documentation, you are
233234
probably comfortable with all the Git-magic involved in the process. That's
234-
why your next contributions would be much faster and easier. Here you can find
235-
the complete steps to contribute to Symfony documentation, which you can use as
236-
a **checklist**:
235+
why your next contributions would be much faster. Here you can find the complete
236+
steps to contribute to the Symfony documentation, which you can use as a
237+
**checklist**:
237238

238239
.. code-block:: bash
239240
@@ -273,8 +274,8 @@ You guessed right: after all this hard work, it's **time to celebrate again!**
273274
Frequently Asked Questions
274275
--------------------------
275276

276-
Why Do my Changes so Long to Be Reviewed and/or Merged?
277-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277+
Why Do my Changes Take so Long to Be Reviewed and/or Merged?
278+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278279

279280
Please be patient. It can take up to several days before your pull request can
280281
be fully reviewed. After merging the changes, it could take again several hours
@@ -301,7 +302,7 @@ What If I Want to Submit my Work without Fully Finishing It?
301302
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
302303

303304
You can do it. But please use one of these two prefixes to let reviewers know
304-
which is the state of your work:
305+
about the state of your work:
305306

306307
* ``[WIP]`` (Work in Progress) is used when you are not yet finished with your
307308
pull request, but you would like it to be reviewed. The pull request won't
@@ -312,14 +313,15 @@ which is the state of your work:
312313
will not be merged until it is merged in the core code (or closed if the
313314
change is rejected).
314315

315-
Would You Admit a Huge Pull Request with Lots of Changes?
316-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
316+
Would You Accept a Huge Pull Request with Lots of Changes?
317+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
317318

318319
First, make sure that the changes are somewhat related. Otherwise, please create
319320
separate pull requests. Anyway, before submitting a huge change, it's probably a
320321
good idea to open an issue in the Symfony Documentation repository to ask the
321322
managers if they agree with your proposed changes. Otherwise, they could refuse
322-
your proposal after having made all the work and you would have wasted a lot of time.
323+
your proposal after you put all that hard work into making the changes. We
324+
definitely don't want you to waste your time!
323325

324326
.. _`github.com/symfony/symfony-docs`: https://github.com/symfony/symfony-docs
325327
.. _reStructuredText: http://docutils.sourceforge.net/rst.html

0 commit comments

Comments
 (0)