Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9f8d766

Browse files
committed
Merge branch '2.8'
* 2.8: Added example on PR IDs Simplified/improved wording
2 parents bb2f991 + f96eecf commit 9f8d766

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

contributing/community/reviews.rst

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,16 @@ The steps for the review are:
6060

6161
Download the reproduction project and test whether the bug can be reproduced
6262
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`_.
6564

6665
#. **Update the Issue Status**
6766

6867
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:
7371

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
7573
reproduced, explain what information is missing and move the report to this
7674
status.
7775

@@ -98,12 +96,12 @@ The steps for the review are:
9896
The Pull Request Review Process
9997
-------------------------------
10098

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.
105103

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
107105
you got and leave the PR in "Needs Review" state.
108106

109107
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:
130128

131129
Read the issue that the pull request is supposed to fix. Reproduce the
132130
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.
134133

135134
#. **Review the Code**
136135

@@ -150,29 +149,38 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps:
150149
latest UPGRADE-X.X.md file? Do those explanations contain "Before"/"After"
151150
examples with clear upgrade instructions?
152151

153-
Eventually, some of these aspects will be checked automatically.
152+
.. note::
153+
154+
Eventually, some of these aspects will be checked automatically.
154155

155156
#. **Test the Code**
156157

157158
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:
160162

161163
.. code-block:: text
162164
163165
$ cd vendor/symfony/symfony
164166
$ git fetch origin pull/<ID>/head:pr<ID>
165167
$ git checkout pr<ID>
166168
169+
For example:
170+
171+
.. code-block:: text
172+
173+
$ git fetch origin pull/15723/head:pr15723
174+
$ git checkout pr15723
175+
167176
Now you can test the project against the code in the PR.
168177

169178
#. **Update the PR Status**
170179

171180
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:
176184

177185
**Needs Work** If the PR is not yet ready to be merged, explain the issues
178186
that you found and move it to this status.

0 commit comments

Comments
 (0)