From a345464efddc5a58f48a475142932dd20200faa0 Mon Sep 17 00:00:00 2001 From: Daniel Coquelin Date: Thu, 16 Jan 2020 16:41:46 +0100 Subject: [PATCH] Update pull_request_template.md --- docs/pull_request_template.md | 36 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index e61e94249c..a52b11ac61 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,11 +1,11 @@ ## Description -Please include a summary of the change and which issue/s is/are fixed. +Include a summary of the change/s. Please also include relevant motivation and context. List any dependencies that are required for this change. -Fixes: # +Issue/s resolved: # -Changes proposed: +## Changes proposed: - - - @@ -13,25 +13,17 @@ Changes proposed: ## Type of change -Select relevant options. +Remove irrelevant options: +- 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 update -- [ ] 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 update +## Due Diligence -Are all split configurations tested and accounted for? -- [ ] yes -- [ ] no +- [ ] All split configurations tested +- [ ] Multiple dtypes tested in relavent functions +- [ ] Documentation updated (if needed) -Does this change require a documentation update outside of the changes proposed? -- [ ] yes -- [ ] no - -Does this change modify the behaviour of other functions? -- [ ] yes -- [ ] no - -Are there code practices which require justification? -- [ ] yes -- [ ] no +#### Does this change modify the behaviour of other functions? If so, which? +yes / no