@@ -3,11 +3,12 @@ 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
- 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 .
7
7
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
9
9
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.
11
12
12
13
Before Your First Contribution
13
14
------------------------------
@@ -22,20 +23,20 @@ The Symfony documentation is hosted on GitHub:
22
23
If you are not familiar with this format, read :doc: `this article </contributing/documentation/format >`
23
24
for a quick overview of its basic features.
24
25
* Symfony documentation is hosted on GitHub _. You'll need a GitHub user account
25
- to contribute documentation.
26
+ to contribute to the documentation.
26
27
* Symfony documentation is published under a
27
28
:doc: `Creative Commons BY-SA 3.0 License </contributing/documentation/license >`
28
29
and all your contributions will implicitly adhere to that license.
29
30
30
31
Your First Documentation Contribution
31
32
-------------------------------------
32
33
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 .
36
37
37
38
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:
39
40
40
41
**Step 1. ** Go to the official Symfony documentation repository located at
41
42
`github.com/symfony/symfony-docs `_ and `fork the repository `_ to your personal
@@ -58,7 +59,7 @@ Nowadays this is the ``2.3`` branch:
58
59
$ cd symfony-docs/
59
60
$ git checkout 2.3
60
61
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
62
63
version which included it: ``2.5 ``, ``2.6 ``, etc.
63
64
64
65
<<<<<<< HEAD
@@ -88,15 +89,15 @@ doc:`/contributing/documentation/standards`.
88
89
>>>>>>> Revamped the documentation about "Contributing Docs"
89
90
90
91
$ git commit book/installation.rst
91
- $ git push
92
+ $ git push origin improve_install_chapter
92
93
93
94
**Step 7. ** Everything is now ready to initiate a **pull request **. Go to your
94
95
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.
96
97
97
98
Then, click on the big ``New pull request `` button. As GitHub cannot guess the
98
99
exact changes that you want to propose, select the appropriate branches where
99
- changes should be applied:
100
+ changes should be applied:º
100
101
101
102
.. image :: /images/docs-pull-request-change-base.png
102
103
:align: center
@@ -105,10 +106,10 @@ In this example, the **base repository** should be ``symfony/symfony-docs`` and
105
106
the **base branch ** should be the ``2.3 ``, which is the branch that you selected
106
107
to base your changes on. The **compare repository ** should be your forked copy
107
108
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.
109
110
110
111
**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
112
113
at the beginning of your pull request description:
113
114
114
115
.. code-block :: text
@@ -137,7 +138,7 @@ carefully review your work in short time and they will let you know about any
137
138
required change.
138
139
139
140
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
141
142
changes and push them:
142
143
143
144
.. code-block :: bash
@@ -167,18 +168,17 @@ The first contribution took some time because you had to fork the repository,
167
168
learn how to write documentation, comply with the pull requests standards, etc.
168
169
The second contribution will be much easier, except for one detail: given the
169
170
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.
171
172
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:
175
175
176
176
.. code-block :: bash
177
177
178
178
$ cd projects/symfony-docs/
179
179
$ git remote add upstream https://github.com/symfony/symfony-docs.git
180
180
181
- Now you can **sync your fork ** executing the following command:
181
+ Now you can **sync your fork ** by executing the following command:
182
182
183
183
.. code-block :: bash
184
184
@@ -196,7 +196,8 @@ tags would be removed from the new 2.5 branch.
196
196
$ git merge upstream/master
197
197
>>>>>>> Revamped the documentation about "Contributing Docs"
198
198
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:
200
201
201
202
.. code-block :: bash
202
203
@@ -222,18 +223,18 @@ Now you can proceed following the same steps explained in the previous section:
222
223
# | Applies to | [Symfony version numbers this applies to]
223
224
# | Fixed tickets | [comma separated list of tickets fixed by the PR]
224
225
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
227
228
`Symfony Documentation Contributors `_.
228
229
229
230
Your Next Documentation Contributions
230
231
-------------------------------------
231
232
232
233
Now that you've made two contributions to the Symfony documentation, you are
233
234
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 **:
237
238
238
239
.. code-block :: bash
239
240
@@ -273,8 +274,8 @@ You guessed right: after all this hard work, it's **time to celebrate again!**
273
274
Frequently Asked Questions
274
275
--------------------------
275
276
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
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278
279
279
280
Please be patient. It can take up to several days before your pull request can
280
281
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?
301
302
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
302
303
303
304
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:
305
306
306
307
* ``[WIP] `` (Work in Progress) is used when you are not yet finished with your
307
308
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:
312
313
will not be merged until it is merged in the core code (or closed if the
313
314
change is rejected).
314
315
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
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
317
318
318
319
First, make sure that the changes are somewhat related. Otherwise, please create
319
320
separate pull requests. Anyway, before submitting a huge change, it's probably a
320
321
good idea to open an issue in the Symfony Documentation repository to ask the
321
322
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!
323
325
324
326
.. _`github.com/symfony/symfony-docs` : https://github.com/symfony/symfony-docs
325
327
.. _reStructuredText : http://docutils.sourceforge.net/rst.html
0 commit comments