Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit6796ba8

Browse files
committed
[Contributing] Fix single vs double backtick issues
1 parentb35e62b commit6796ba8

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

‎contributing/code/patches.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Get the Symfony2 source code:
7272
* Fork the `Symfony2 repository`_ (click on the "Fork" button);
7373

7474
* After the "forking action" has completed, clone your fork locally
75-
(this will create a `symfony` directory):
75+
(this will create a ``symfony`` directory):
7676

7777
..code-block::bash
7878
@@ -105,16 +105,16 @@ Choose the right Branch
105105
~~~~~~~~~~~~~~~~~~~~~~~
106106

107107
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
109109
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``).
111111

112112
..note::
113113

114114
All bug fixes merged into maintenance branches are also merged into more
115115
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.
118118

119119
Create a Topic Branch
120120
~~~~~~~~~~~~~~~~~~~~~
@@ -126,26 +126,26 @@ topic branch:
126126
127127
$ git checkout -b BRANCH_NAME master
128128
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:
131131

132132
..code-block::bash
133133
134134
$ git checkout -t origin/2.2
135135
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:
137137

138138
..code-block::bash
139139
140140
$ git checkout -b BRANCH_NAME 2.2
141141
142142
..tip::
143143

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
145145
ticket number is a good convention for bug fixes).
146146

147147
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``).
149149

150150
Work on your Patch
151151
~~~~~~~~~~~~~~~~~~
@@ -154,7 +154,7 @@ Work on the code as much as you want and commit as much as you want; but keep
154154
in mind the following:
155155

156156
* 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
158158
trailing spaces -- also read the tip below);
159159

160160
* Add unit tests to prove that the bug is fixed or that the new feature
@@ -164,7 +164,7 @@ in mind the following:
164164
provide a compatibility layer to support the old way) -- patches that break
165165
backward compatibility have less chance to be merged;
166166

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
168168
have a clean and logical history);
169169

170170
* Squash irrelevant commits that are just about fixing coding standards or
@@ -199,11 +199,11 @@ Prepare your Patch for Submission
199199
When your patch is not about a bug fix (when you add a new feature or change
200200
an existing one for instance), it must also include the following:
201201

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);
204204

205205
* 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
207207
deprecate something that will ultimately break backward compatibility.
208208

209209
Step 3: Submit your Patch
@@ -254,7 +254,7 @@ You can now make a pull request on the ``symfony/symfony`` Github repository.
254254
..tip::
255255

256256
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.
258258

259259
To ease the core team work, always include the modified components in your
260260
pull request message, like in:
@@ -317,10 +317,10 @@ Some answers to the questions trigger some more requirements:
317317
documentation and reference it under the "Doc PR" section;
318318

319319
* 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;
321321

322322
* 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;
324324

325325
* If you answer no to "Tests pass", you must add an item to a todo-list with
326326
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:
394394
pick 7fc64b4 second commit
395395
pick 7d33018 third commit
396396
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 toedit the commit message, which by default is a listing of the commit
401+
messagesof all the commits. When you finish, execute the push command.
402402

403403
.. _ProGit:http://git-scm.com/book
404404
.. _GitHub:https://github.com/signup/free

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp