@@ -72,7 +72,7 @@ Get the Symfony2 source code:
72
72
* Fork the `Symfony2 repository `_ (click on the "Fork" button);
73
73
74
74
* After the "forking action" has completed, clone your fork locally
75
- (this will create a `symfony ` directory):
75
+ (this will create a `` symfony ` ` directory):
76
76
77
77
.. code-block :: bash
78
78
@@ -105,16 +105,16 @@ Choose the right Branch
105
105
~~~~~~~~~~~~~~~~~~~~~~~
106
106
107
107
Before working on a patch, you must determine on which branch you need to
108
- work. The branch should be based on the `master ` branch if you want to add a
108
+ work. The branch should be based on the `` master ` ` branch if you want to add a
109
109
new feature. But if you want to fix a bug, use the oldest but still maintained
110
- version of Symfony where the bug happens (like `2.2 `).
110
+ version of Symfony where the bug happens (like `` 2.2 ` `).
111
111
112
112
.. note ::
113
113
114
114
All bug fixes merged into maintenance branches are also merged into more
115
115
recent branches on a regular basis. For instance, if you submit a patch
116
- for the `2.2 ` branch, the patch will also be applied by the core team on
117
- the `master ` branch.
116
+ for the `` 2.2 ` ` branch, the patch will also be applied by the core team on
117
+ the `` master ` ` branch.
118
118
119
119
Create a Topic Branch
120
120
~~~~~~~~~~~~~~~~~~~~~
@@ -126,26 +126,26 @@ topic branch:
126
126
127
127
$ git checkout -b BRANCH_NAME master
128
128
129
- Or, if you want to provide a bugfix for the 2.2 branch, first track the remote
130
- `2.2 ` branch locally:
129
+ Or, if you want to provide a bugfix for the `` 2.2 `` branch, first track the remote
130
+ `` 2.2 ` ` branch locally:
131
131
132
132
.. code-block :: bash
133
133
134
134
$ git checkout -t origin/2.2
135
135
136
- Then create a new branch off the 2.2 branch to work on the bugfix:
136
+ Then create a new branch off the `` 2.2 `` branch to work on the bugfix:
137
137
138
138
.. code-block :: bash
139
139
140
140
$ git checkout -b BRANCH_NAME 2.2
141
141
142
142
.. tip ::
143
143
144
- Use a descriptive name for your branch (`ticket_XXX ` where `XXX ` is the
144
+ Use a descriptive name for your branch (`` ticket_XXX `` where `` XXX ` ` is the
145
145
ticket number is a good convention for bug fixes).
146
146
147
147
The above checkout commands automatically switch the code to the newly created
148
- branch (check the branch you are working on with `git branch `).
148
+ branch (check the branch you are working on with `` git branch ` `).
149
149
150
150
Work on your Patch
151
151
~~~~~~~~~~~~~~~~~~
@@ -154,7 +154,7 @@ Work on the code as much as you want and commit as much as you want; but keep
154
154
in mind the following:
155
155
156
156
* Read about the Symfony :doc: `conventions <conventions >` and follow the
157
- coding :doc: `standards <standards >` (use `git diff --check ` to check for
157
+ coding :doc: `standards <standards >` (use `` git diff --check ` ` to check for
158
158
trailing spaces -- also read the tip below);
159
159
160
160
* Add unit tests to prove that the bug is fixed or that the new feature
@@ -164,7 +164,7 @@ in mind the following:
164
164
provide a compatibility layer to support the old way) -- patches that break
165
165
backward compatibility have less chance to be merged;
166
166
167
- * Do atomic and logically separate commits (use the power of `git rebase ` to
167
+ * Do atomic and logically separate commits (use the power of `` git rebase ` ` to
168
168
have a clean and logical history);
169
169
170
170
* Squash irrelevant commits that are just about fixing coding standards or
@@ -199,11 +199,11 @@ Prepare your Patch for Submission
199
199
When your patch is not about a bug fix (when you add a new feature or change
200
200
an existing one for instance), it must also include the following:
201
201
202
- * An explanation of the changes in the relevant CHANGELOG file(s) (the `` [BC
203
- BREAK] `` or the ``[DEPRECATION] `` prefix must be used when relevant);
202
+ * An explanation of the changes in the relevant `` CHANGELOG `` file(s) (the
203
+ `` [BC BREAK] `` or the ``[DEPRECATION] `` prefix must be used when relevant);
204
204
205
205
* An explanation on how to upgrade an existing application in the relevant
206
- UPGRADE file(s) if the changes break backward compatibility or if you
206
+ `` UPGRADE `` file(s) if the changes break backward compatibility or if you
207
207
deprecate something that will ultimately break backward compatibility.
208
208
209
209
Step 3: Submit your Patch
@@ -254,7 +254,7 @@ You can now make a pull request on the ``symfony/symfony`` Github repository.
254
254
.. tip ::
255
255
256
256
Take care to point your pull request towards ``symfony:2.2 `` if you want
257
- the core team to pull a bugfix based on the 2.2 branch.
257
+ the core team to pull a bugfix based on the `` 2.2 `` branch.
258
258
259
259
To ease the core team work, always include the modified components in your
260
260
pull request message, like in:
@@ -317,10 +317,10 @@ Some answers to the questions trigger some more requirements:
317
317
documentation and reference it under the "Doc PR" section;
318
318
319
319
* If you answer yes to "BC breaks?", the patch must contain updates to the
320
- relevant CHANGELOG and UPGRADE files;
320
+ relevant `` CHANGELOG `` and `` UPGRADE `` files;
321
321
322
322
* If you answer yes to "Deprecations?", the patch must contain updates to the
323
- relevant CHANGELOG and UPGRADE files;
323
+ relevant `` CHANGELOG `` and `` UPGRADE `` files;
324
324
325
325
* If you answer no to "Tests pass", you must add an item to a todo-list with
326
326
the actions that must be done to fix the tests;
@@ -394,11 +394,11 @@ type this command, an editor will popup showing a list of commits:
394
394
pick 7fc64b4 second commit
395
395
pick 7d33018 third commit
396
396
397
- To squash all commits into the first one, remove the word " pick" before the
398
- second and the last commits, and replace it by the word " squash" or just "s".
399
- When you save, Git will start rebasing, and if successful, will ask you to
400
- edit the commit message, which by default is a listing of the commit messages
401
- of all the commits. When you finish, execute the push command.
397
+ To squash all commits into the first one, remove the word `` pick `` before the
398
+ second and the last commits, and replace it by the word `` squash `` or just
399
+ `` s ``. When you save, Git will start rebasing, and if successful, will ask
400
+ you to edit the commit message, which by default is a listing of the commit
401
+ messages of all the commits. When you finish, execute the push command.
402
402
403
403
.. _ProGit : http://git-scm.com/book
404
404
.. _GitHub : https://github.com/signup/free
0 commit comments