simplify pull request template #219
Conversation
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - | ||
|
|
||
| ## Testing | ||
|
|
||
| 1. | ||
|
|
There was a problem hiding this comment.
I'm proposing replacing this + Testing checklist with a section simply titled How I tested this.
I think having two sections that are both asking "how did you test this?" is confusing, as is having a checklist of two specific Python versions (how do I test on those versions? all the tests (e.g. Dask), or just the main ones?
Having a checklist of specific versions also requires some maintenance effort as the range of support Python versions for the project changes.
There was a problem hiding this comment.
yep thanks -- I was thinking that myself the other day that I was repeating myself.
There was a problem hiding this comment.
we can always add back asking about versions if we need to, so this sounds good.
There was a problem hiding this comment.
@jameslamb on second thought, thoughts on putting the testing section here versus at the end? I think my natural flow would be to list changes, and then list how I tested them? Thoughts? Otherwise the rest of this looks good.
There was a problem hiding this comment.
Ok yeah, that works for me! I don't have a strong preference about the ordering.
Just pushed moving testing up.
So the order looks like this now: 0333362
|
Ok I'm done adding notes. Thanks very much for considering this! |
This PR proposes some simplifications to the pull request template.
I believe it'll make contributing a bit less intimidating for beginners, and reduce the amount of boilerplate text that has to be read by maintainers reviewing PRs.
Changes
I'll leave inline comments explaining each proposed change.
Testing
N/A
Notes
N/A
Checklist