Skip to content

Commit 88ddbb1

Browse files
committed
Fixed all the errors found by Ryan
1 parent baa06b5 commit 88ddbb1

File tree

2 files changed

+35
-33
lines changed

2 files changed

+35
-33
lines changed

contributing/documentation/format.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ If you want to modify that title, use this alternative syntax:
156156
:doc:`environments`
157157
158158
**Links to the API** follow a different syntax, where you must specify the type
159-
of linked resource (``namespace``, ``class`` or ``method``):
159+
of the linked resource (``namespace``, ``class`` or ``method``):
160160

161161
.. code-block:: rst
162162

contributing/documentation/overview.rst

+34-32
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
------------------------------
@@ -18,20 +19,20 @@ Before Your First Contribution
1819
If you are not familiar with this format, read :doc:`this article </contributing/documentation/format>`
1920
for a quick overview of its basic features.
2021
* Symfony documentation is hosted on GitHub_. You'll need a GitHub user account
21-
to contribute documentation.
22+
to contribute to the documentation.
2223
* Symfony documentation is published under a
2324
:doc:`Creative Commons BY-SA 3.0 License </contributing/documentation/license>`
2425
and all your contributions will implicitly adhere to that license.
2526

2627
Your First Documentation Contribution
2728
-------------------------------------
2829

29-
In this section you'll learn how to contribute to Symfony documentation for the
30-
first time. Next section will explain the abbreviated process to follow for the
31-
next contributions.
30+
In this section you'll learn how to contribute to the Symfony documentation for
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.
3233

3334
Let's imagine that you want to improve the installation chapter of the Symfony
34-
book. In order to do those changes, follow these steps:
35+
book. In order to make your changes, follow these steps:
3536

3637
**Step 1.** Go to the official Symfony documentation repository located at
3738
`github.com/symfony/symfony-docs`_ and `fork the repository`_ to your personal
@@ -54,7 +55,7 @@ Nowadays this is the ``2.3`` branch:
5455
$ cd symfony-docs/
5556
$ git checkout 2.3
5657
57-
If you were instead documenting a new feature, switch to the first Symfony
58+
If you are instead documenting a new feature, switch to the first Symfony
5859
version which included it: ``2.5``, ``2.6``, etc.
5960

6061
**Step 4.** Create a dedicated **new branch** for your changes. This greatly
@@ -74,15 +75,15 @@ doc:`/contributing/documentation/standards`.
7475
.. code-block:: bash
7576
7677
$ git commit book/installation.rst
77-
$ git push
78+
$ git push origin improve_install_chapter
7879
7980
**Step 7.** Everything is now ready to initiate a **pull request**. Go to your
8081
forked repository at ``https//github.com/<YOUR GITHUB USERNAME>/symfony-docs``
81-
and click on the ``Pull Requests`` link located at the sidebar.
82+
and click on the ``Pull Requests`` link located in the sidebar.
8283

8384
Then, click on the big ``New pull request`` button. As GitHub cannot guess the
8485
exact changes that you want to propose, select the appropriate branches where
85-
changes should be applied:
86+
changes should be applied:º
8687

8788
.. image:: /images/docs-pull-request-change-base.png
8889
:align: center
@@ -91,10 +92,10 @@ In this example, the **base repository** should be ``symfony/symfony-docs`` and
9192
the **base branch** should be the ``2.3``, which is the branch that you selected
9293
to base your changes on. The **compare repository** should be your forked copy
9394
of ``symfony-docs`` and the **compare branch** should be ``improve_install_chapter``,
94-
which is the name that you selected to work on your changes.
95+
which is the name of the branch you created and where you made your changes.
9596

9697
**Step 8.** The last step is to prepare the **description** of the pull request.
97-
To ensure that your work is reviewed quickly, you have to add the following table
98+
To ensure that your work is reviewed quickly, please add the following table
9899
at the beginning of your pull request description:
99100

100101
.. code-block:: text
@@ -123,7 +124,7 @@ carefully review your work in short time and they will let you know about any
123124
required change.
124125

125126
In case you need to add or modify anything, there is no need to create a new
126-
pull request. Just make sure that you are in the correct branch, make your
127+
pull request. Just make sure that you are on the correct branch, make your
127128
changes and push them:
128129

129130
.. code-block:: bash
@@ -147,18 +148,17 @@ The first contribution took some time because you had to fork the repository,
147148
learn how to write documentation, comply with the pull requests standards, etc.
148149
The second contribution will be much easier, except for one detail: given the
149150
furious update activity of the Symfony documentation repository, odds are that
150-
your fork is now outdated comparing it with the official repository.
151+
your fork is now out of date with the official repository.
151152

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

156156
.. code-block:: bash
157157
158158
$ cd projects/symfony-docs/
159159
$ git remote add upstream https://github.com/symfony/symfony-docs.git
160160
161-
Now you can **sync your fork** executing the following command:
161+
Now you can **sync your fork** by executing the following command:
162162

163163
.. code-block:: bash
164164
@@ -167,7 +167,8 @@ Now you can **sync your fork** executing the following command:
167167
$ git checkout master
168168
$ git merge upstream/master
169169
170-
Now you can proceed following the same steps explained in the previous section:
170+
Great! Now you can proceed by following the same steps explained in the previous
171+
section:
171172

172173
.. code-block:: bash
173174
@@ -193,18 +194,18 @@ Now you can proceed following the same steps explained in the previous section:
193194
# | Applies to | [Symfony version numbers this applies to]
194195
# | Fixed tickets | [comma separated list of tickets fixed by the PR]
195196
196-
Your second contribution is now completed, so **go and celebrate again!**
197-
You will also see how your ranking improves in the list of
197+
Your second contribution is now complete, so **go and celebrate again!**
198+
You can also see how your ranking improves in the list of
198199
`Symfony Documentation Contributors`_.
199200

200201
Your Next Documentation Contributions
201202
-------------------------------------
202203

203204
Now that you've made two contributions to the Symfony documentation, you are
204205
probably comfortable with all the Git-magic involved in the process. That's
205-
why your next contributions would be much faster and easier. Here you can find
206-
the complete steps to contribute to Symfony documentation, which you can use as
207-
a **checklist**:
206+
why your next contributions would be much faster. Here you can find the complete
207+
steps to contribute to the Symfony documentation, which you can use as a
208+
**checklist**:
208209

209210
.. code-block:: bash
210211
@@ -244,8 +245,8 @@ You guessed right: after all this hard work, it's **time to celebrate again!**
244245
Frequently Asked Questions
245246
--------------------------
246247

247-
Why Do my Changes so Long to Be Reviewed and/or Merged?
248-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248+
Why Do my Changes Take so Long to Be Reviewed and/or Merged?
249+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249250

250251
Please be patient. It can take up to several days before your pull request can
251252
be fully reviewed. After merging the changes, it could take again several hours
@@ -272,7 +273,7 @@ What If I Want to Submit my Work without Fully Finishing It?
272273
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273274

274275
You can do it. But please use one of these two prefixes to let reviewers know
275-
which is the state of your work:
276+
about the state of your work:
276277

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

286-
Would You Admit a Huge Pull Request with Lots of Changes?
287-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
287+
Would You Accept a Huge Pull Request with Lots of Changes?
288+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
288289

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

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

0 commit comments

Comments
 (0)