Skip to content

Commit bc000ac

Browse files
authored
Provide some examples on how to leave PR reviews (python#452)
1 parent 7eee92f commit bc000ac

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

pullrequest.rst

+15
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,21 @@ code and leave comments in the pull request or issue tracker.
393393
However, please be aware that if you are recommending a pull request as
394394
'merge-ready', you should always make sure the entire test suite passes.
395395

396+
Leaving a Pull Request Review on GitHub
397+
---------------------------------------
398+
399+
When you review a pull request, you should provide additional details and context
400+
of your review process.
401+
402+
Instead of simply "approving" the pull request, leave comments. For example:
403+
404+
#. If you tested the PR, report the result and the system and version tested on,
405+
such as 'Windows 10', 'Ubuntu 16.4', or 'Mac High Sierra'.
406+
407+
#. If you request changes, try to suggest how.
408+
409+
#. Comment on what is "good" about the pull request, not just the "bad". Doing
410+
so will make it easier for the PR author to find the good in your comments.
396411

397412
Dismissing Review from Another Core Developer
398413
---------------------------------------------

0 commit comments

Comments
 (0)