@@ -60,18 +60,16 @@ The steps for the review are:
60
60
61
61
Download the reproduction project and test whether the bug can be reproduced
62
62
on your system. If the reporter did not provide a reproduction project,
63
- create one by forking _ the `Symfony Standard Edition `_. Reproduce the bug
64
- with the instructions given by the reporter.
63
+ create one by forking _ the `Symfony Standard Edition `_.
65
64
66
65
#. **Update the Issue Status **
67
66
68
67
At last, add a comment to the bug report. **Thank the reporter for reporting
69
- the bug **. Include the line ``Status: <status> `` in your comment to update
70
- the status of the ticket. This line will trigger our `Carson Bot `_ which
71
- updates the labels of the issue accordingly. You can set the status to one of
72
- the following:
68
+ the bug **. Include the line ``Status: <status> `` in your comment to trigger
69
+ our `Carson Bot `_ which updates the status label of the issue. You can set
70
+ the status to one of the following:
73
71
74
- **Needs Work ** If the bug does not contain enough information to be
72
+ **Needs Work ** If the bug * does not * contain enough information to be
75
73
reproduced, explain what information is missing and move the report to this
76
74
status.
77
75
@@ -98,12 +96,12 @@ The steps for the review are:
98
96
The Pull Request Review Process
99
97
-------------------------------
100
98
101
- The process for reviewing pull requests (PRs) is similar to doing a review of a
102
- bug report . Reviews of pull requests usually take a little longer since you need
103
- to understand the functionality that has been fixed or implemented and then find
104
- out whether the implementation is complete.
99
+ The process for reviewing pull requests (PRs) is similar to the one for bug
100
+ reports . Reviews of pull requests usually take a little longer since you need
101
+ to understand the functionality that has been fixed or added and find out
102
+ whether the implementation is complete.
105
103
106
- It is okay to do partial reviews. If you do a partial review, comment how far
104
+ It is okay to do partial reviews! If you do a partial review, comment how far
107
105
you got and leave the PR in "Needs Review" state.
108
106
109
107
Pick a pull request from the `PRs in need of review `_ and follow these steps:
@@ -130,7 +128,8 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps:
130
128
131
129
Read the issue that the pull request is supposed to fix. Reproduce the
132
130
problem on a clean `Symfony Standard Edition `_ project and try to understand
133
- why it exists.
131
+ why it exists. If the linked issue already contains such a project, install
132
+ it and run it on your system.
134
133
135
134
#. **Review the Code **
136
135
@@ -150,29 +149,38 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps:
150
149
latest UPGRADE-X.X.md file? Do those explanations contain "Before"/"After"
151
150
examples with clear upgrade instructions?
152
151
153
- Eventually, some of these aspects will be checked automatically.
152
+ .. note ::
153
+
154
+ Eventually, some of these aspects will be checked automatically.
154
155
155
156
#. **Test the Code **
156
157
157
158
Take your project from step 3 and test whether the PR works properly.
158
- Replace the Symfony vendor by the code in the PR by running the following Git
159
- commands. Insert the PR ID for the ``<ID> `` placeholders:
159
+ Replace the Symfony project in the ``vendor `` directory by the code in the
160
+ PR by running the following Git commands. Insert the PR ID (that's the number
161
+ after the ``# `` in the PR title) for the ``<ID> `` placeholders:
160
162
161
163
.. code-block :: text
162
164
163
165
$ cd vendor/symfony/symfony
164
166
$ git fetch origin pull/<ID>/head:pr<ID>
165
167
$ git checkout pr<ID>
166
168
169
+ For example:
170
+
171
+ .. code-block :: text
172
+
173
+ $ git fetch origin pull/15723/head:pr15723
174
+ $ git checkout pr15723
175
+
167
176
Now you can test the project against the code in the PR.
168
177
169
178
#. **Update the PR Status **
170
179
171
180
At last, add a comment to the PR. **Thank the contributor for working on the
172
- PR **. Include the line ``Status: <status> `` in your comment to update the
173
- status of the ticket. This line will trigger our `Carson Bot `_ which updates
174
- the labels of the issue accordingly. You can set the status to one of the
175
- following:
181
+ PR **. Include the line ``Status: <status> `` in your comment to trigger our
182
+ `Carson Bot `_ which updates the status label of the issue. You can set the
183
+ status to one of the following:
176
184
177
185
**Needs Work ** If the PR is not yet ready to be merged, explain the issues
178
186
that you found and move it to this status.
0 commit comments