@@ -26,12 +26,12 @@ then clone your fork:
26
26
$ git clone git://github.com/YOURUSERNAME/symfony-docs.git
27
27
28
28
Consistent with Symfony's source code, the documentation repository is split into
29
- three branches: ``2.0 `` for the current Symfony 2.0.x release, ``2.1 `` for the
30
- current Symfony 2.1.x release and ``master `` as the development branch for
29
+ three branches: ``2.0 `` for the current Symfony 2.0.x release, ``2.1 `` for the
30
+ current Symfony 2.1.x release and ``master `` as the development branch for
31
31
upcoming releases.
32
32
33
33
Unless you're documenting a feature that's new to Symfony 2.1, your changes
34
- should always be based on the 2.0 branch instead of the master branch. To do
34
+ should always be based on the 2.0 branch instead of the master branch. To do
35
35
this checkout the 2.0 branch before the next step:
36
36
37
37
.. code-block :: bash
@@ -52,7 +52,7 @@ the ``symfony-docs`` ``master`` branch.
52
52
.. image :: /images/docs-pull-request.png
53
53
:align: center
54
54
55
- If you have made your changes based on the 2.0 branch then you need to change
55
+ If you have made your changes based on the 2.0 branch then you need to change
56
56
the base branch to be 2.0 on the preview page:
57
57
58
58
.. image :: /images/docs-pull-request-change-base.png
@@ -61,7 +61,7 @@ the base branch to be 2.0 on the preview page:
61
61
.. note ::
62
62
63
63
All changes made to the 2.0 branch will be merged into 2.1 which in turn will be
64
- merged into the master branch for the next release on a weekly basis.
64
+ merged into the master branch for the next release on a weekly basis.
65
65
66
66
GitHub covers the topic of `pull requests `_ in detail.
67
67
@@ -73,9 +73,9 @@ GitHub covers the topic of `pull requests`_ in detail.
73
73
.. tip ::
74
74
75
75
Please be patient. It can take from 15 minutes to several days for your changes
76
- to appear on the symfony.com website after the documentation team merges your
77
- pull request. You can check if your changes have introduced some markup issues
78
- by going to the `Documentation Build Errors `_ page (it is updated each French
76
+ to appear on the symfony.com website after the documentation team merges your
77
+ pull request. You can check if your changes have introduced some markup issues
78
+ by going to the `Documentation Build Errors `_ page (it is updated each French
79
79
night at 3AM when the server rebuilds the documentation).
80
80
81
81
Standards
@@ -88,19 +88,19 @@ look and feel familiar, you should follow these rules:
88
88
as well as the `Twig Coding Standards `_;
89
89
* Each line should break approximately after the first word that crosses the
90
90
72nd character (so most lines end up being 72-78 lines);
91
- * When we fold one or more lines of code, we place ``... `` in a comment at the point
91
+ * When you fold one or more lines of code, place ``... `` in a comment at the point
92
92
of the fold. These comments are: ``// ... `` (php), ``# ... `` (yaml/bash), ``{# ... #} ``
93
93
(twig), ``<!-- ... --> `` (xml/html), ``; ... `` (ini), ``... `` (text);
94
- * When we fold a part of a line, e.g. a variable value, we put ``... `` (without comment)
94
+ * When you fold a part of a line, e.g. a variable value, put ``... `` (without comment)
95
95
at the place of the fold;
96
96
* Description of the folded code: (optional)
97
- If we fold several lines: the description of the fold can be placed after the ``... ``
98
- If we fold only part of a line: the description can be placed before the line;
97
+ If you fold several lines: the description of the fold can be placed after the ``... ``
98
+ If you fold only part of a line: the description can be placed before the line;
99
99
* If useful, a ``codeblock `` should begin with a comment containing the filename
100
100
of the file in the code block. Don't place a blank line after this comment,
101
101
unless the next line is also a comment;
102
102
* You should put a ``$ `` in front of every bash line;
103
- * We prefer the ``:: `` shorthand over ``.. code-block:: php `` to begin a PHP
103
+ * The ``:: `` shorthand is preferred over ``.. code-block:: php `` to begin a PHP
104
104
code block.
105
105
106
106
An example::
0 commit comments