From 1bf11a953c185034cd05294189e1c8b62424ea8d Mon Sep 17 00:00:00 2001 From: Mariatta Date: Mon, 4 Feb 2019 10:53:15 -0800 Subject: [PATCH 1/4] Provide some example on how to leave PR reviews --- pullrequest.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/pullrequest.rst b/pullrequest.rst index 0247adcbd..f104547d7 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -393,6 +393,22 @@ code and leave comments in the pull request or issue tracker. However, please be aware that if you are recommending a pull request as 'merge-ready', you should always make sure the entire test suite passes. +Leaving a Pull Request Review on GitHub +--------------------------------------- + +When you review a pull request, you should provide additional details and context +of your review process. + +Instead of simply "approving" the pull request, leave comments, for example: + +1. Whether you have tested the PR + +2. Whether the PR fixes the linked bug/issue + +3. If you requested changes to the pull request, provide suggestions on how it + can be improved. + +4. Leave comments on what's "good" on the pull request, not just the "bad". Dismissing Review from Another Core Developer --------------------------------------------- From da5411336db56831040442558e2db143c190e41a Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Mon, 4 Feb 2019 13:24:05 -0800 Subject: [PATCH 2/4] Apply suggestions from code review Co-Authored-By: Mariatta --- pullrequest.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index f104547d7..2f11ac89f 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -399,7 +399,7 @@ Leaving a Pull Request Review on GitHub When you review a pull request, you should provide additional details and context of your review process. -Instead of simply "approving" the pull request, leave comments, for example: +Instead of simply "approving" the pull request, leave comments. For example: 1. Whether you have tested the PR @@ -408,7 +408,7 @@ Instead of simply "approving" the pull request, leave comments, for example: 3. If you requested changes to the pull request, provide suggestions on how it can be improved. -4. Leave comments on what's "good" on the pull request, not just the "bad". +4. Comment on what is "good" about the pull request, not just the "bad". Dismissing Review from Another Core Developer --------------------------------------------- From a859f2f21c4bab25b17285635dbcafef16c9e6f8 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Mon, 4 Feb 2019 13:26:10 -0800 Subject: [PATCH 3/4] Update pullrequest.rst --- pullrequest.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 2f11ac89f..6a236eb11 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -401,14 +401,13 @@ of your review process. Instead of simply "approving" the pull request, leave comments. For example: -1. Whether you have tested the PR +1. If you tested the PR, report the result and the system and version tested on, + such as 'Windows 10', 'Ubuntu 16.4', or 'Mac High Sierra'. -2. Whether the PR fixes the linked bug/issue +3. If you request changes, try to suggest how. -3. If you requested changes to the pull request, provide suggestions on how it - can be improved. - -4. Comment on what is "good" about the pull request, not just the "bad". +4. Comment on what is "good" about the pull request, not just the "bad". Doing + so will make it easier for the PR author to find the good in your comments. Dismissing Review from Another Core Developer --------------------------------------------- From 2dae4381a47c19071d9e6bdb7f07562459a2048e Mon Sep 17 00:00:00 2001 From: Mariatta Date: Mon, 4 Feb 2019 13:26:35 -0800 Subject: [PATCH 4/4] Update pullrequest.rst --- pullrequest.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 6a236eb11..319e117e6 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -401,12 +401,12 @@ of your review process. Instead of simply "approving" the pull request, leave comments. For example: -1. If you tested the PR, report the result and the system and version tested on, +#. If you tested the PR, report the result and the system and version tested on, such as 'Windows 10', 'Ubuntu 16.4', or 'Mac High Sierra'. -3. If you request changes, try to suggest how. +#. If you request changes, try to suggest how. -4. Comment on what is "good" about the pull request, not just the "bad". Doing +#. Comment on what is "good" about the pull request, not just the "bad". Doing so will make it easier for the PR author to find the good in your comments. Dismissing Review from Another Core Developer