From bb50e8e43ee7c0e267efaa07a34889a2332897b7 Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Thu, 16 Jan 2020 16:05:16 -0800 Subject: [PATCH 1/3] tips --- doc/source/development/contributing.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 4fdcb93745094..8859ce07f24cc 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1525,3 +1525,18 @@ The branch will still exist on GitHub, so to delete it there do:: git push origin --delete shiny-new-feature .. _Gitter: https://gitter.im/pydata/pandas + + +Tips for a successful Pull Request +================================== + +If you have made it to the `Review your code`_ phase one of the core contributors may +take a look. Please note however that a handful of people are responsible for reviewing +all of the contributions, which can often lead to bottlenecks. + +To improve the chances of your pull request being reviewed, you should: + + - **Ensure you have appropriate tests**. These should be the first part of any PR. + - **Keep your pull requests as simple as possible**. Larger PRs take longer to review. + - **Ensure that CI is in a green state**. Reviewers may not even look otherwise. + - **Keep `Updating your pull request`_, either by request or every few days. From c75c4a54cbac046b8fdf60744e65439a80f3ea01 Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Thu, 16 Jan 2020 16:13:14 -0800 Subject: [PATCH 2/3] touchups --- doc/source/development/contributing.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 8859ce07f24cc..b18a0fbc31155 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1536,7 +1536,7 @@ all of the contributions, which can often lead to bottlenecks. To improve the chances of your pull request being reviewed, you should: - - **Ensure you have appropriate tests**. These should be the first part of any PR. - - **Keep your pull requests as simple as possible**. Larger PRs take longer to review. - - **Ensure that CI is in a green state**. Reviewers may not even look otherwise. - - **Keep `Updating your pull request`_, either by request or every few days. + - **Ensure you have appropriate tests**. These should be the first part of any PR + - **Keep your pull requests as simple as possible**. Larger PRs take longer to review + - **Ensure that CI is in a green state**. Reviewers may not even look otherwise + - **Keep** `Updating your pull request`_, either by request or every few days From 648e5322dd4ddd06901b5a93931e65a9f7c8a106 Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Fri, 17 Jan 2020 09:32:45 -0800 Subject: [PATCH 3/3] feedback --- doc/source/development/contributing.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index b18a0fbc31155..2dcb6a32d7941 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1530,13 +1530,14 @@ The branch will still exist on GitHub, so to delete it there do:: Tips for a successful Pull Request ================================== -If you have made it to the `Review your code`_ phase one of the core contributors may +If you have made it to the `Review your code`_ phase, one of the core contributors may take a look. Please note however that a handful of people are responsible for reviewing all of the contributions, which can often lead to bottlenecks. To improve the chances of your pull request being reviewed, you should: - - **Ensure you have appropriate tests**. These should be the first part of any PR - - **Keep your pull requests as simple as possible**. Larger PRs take longer to review - - **Ensure that CI is in a green state**. Reviewers may not even look otherwise - - **Keep** `Updating your pull request`_, either by request or every few days +- **Reference an open issue** for non-trivial changes to clarify the PR's purpose +- **Ensure you have appropriate tests**. These should be the first part of any PR +- **Keep your pull requests as simple as possible**. Larger PRs take longer to review +- **Ensure that CI is in a green state**. Reviewers may not even look otherwise +- **Keep** `Updating your pull request`_, either by request or every few days