From fb3953bb6a84a9ed12b8f049d33c0c0362079965 Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 24 Sep 2020 17:21:26 +0100 Subject: [PATCH 1/5] Add pull request template --- .github/pull_request_template.md | 50 ++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..27bdfa6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,50 @@ +Thank you for contributing to this repository! + +You can help us review your changes by answering these questions. +They are all optional, but the more information you provide the easier it will be for us to review your changes. +Everyone here is a volunteer, so please help us out if you can. + +If you want to discuss anything Jupyter related, or to meet other users and developers, please say hello on https://discourse.jupyter.org/ . + + +### What does this PR do? + + +### List of changes + +- Change X +- Add Y + +### Is this PR related to another issue, or is it part of a larger body of work? + + +### Does this PR introduce a breaking change? + + +### How can this PR be tested? + + +### What should a reviewer concentrate their feedback on? + + +### Other information + From fc888c5652bf71eb9af2ed28e9842e16557964ee Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 1 Oct 2020 20:47:55 +0100 Subject: [PATCH 2/5] Include 'List of changes' in 'What does this PR do?' Try and encourage people to explain why each change was made. --- .github/pull_request_template.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 27bdfa6..49072fb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,16 +12,9 @@ If you want to discuss anything Jupyter related, or to meet other users and deve Please summarise this PR. Please also edit the PR title so that it contains enough context to go into a changelog. Use "Fixes #" if this fixes an existing issue. +It may help to list each change with an explanation of why it's needed- remember that what seems obvious to you may not be obvious to a reviewer. --> -### List of changes - -- Change X -- Add Y - ### Is this PR related to another issue, or is it part of a larger body of work? -### Is this PR related to another issue, or is it part of a larger body of work? +### Is this PR related to an issue, or is it part of a larger body of work? @@ -27,7 +27,7 @@ If so what changes might users need to make in their applications due to this PR ### How can this PR be tested? ### What should a reviewer concentrate their feedback on? From 2e010df5dd4dc47507a1f651296017675f37208b Mon Sep 17 00:00:00 2001 From: Simon Li Date: Mon, 12 Oct 2020 23:24:24 +0100 Subject: [PATCH 4/5] Add type of change checkboxes, Move fixes to related section --- .github/pull_request_template.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9616280..ba7d788 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,15 +9,21 @@ If you want to discuss anything Jupyter related, or to meet other users and deve ### What does this PR do? +Type of change: +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation +- [ ] Other ### Is this PR related to an issue, or is it part of a larger body of work? ### Does this PR introduce a breaking change? From 4899587d271d4ccc79a6849ed2ab18739db29c91 Mon Sep 17 00:00:00 2001 From: Simon Li Date: Tue, 13 Oct 2020 10:58:16 +0100 Subject: [PATCH 5/5] Update .github/pull_request_template.md Co-authored-by: Georgiana Elena --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ba7d788..8c8084c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,4 @@ + ### What does this PR do?