-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update contributor's checklists in PR template #2659
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking care of this!
In the spirit of this PR, I'd go all-in with making the PR template contributor-centric by removing any instruction for the reviewer (in any case, the item about documentation PRs will become obsolete very soon, which leaves the checklist with just one item).
About the contributor part, I'd rephrase it in a way that the recipient of the checklist is obvious, something like:
Pre-flight checklist
- I have read the contributors guidelines
- I have enabled actions on my fork
- If this is a code change, I have added tests and docstrings
- If this is a substantial change, the PR description contains a link to the relevant issue(s)
WDYT?
I have slightly modified your template to keep tests and docstrings separate, and I moved the issues in the top to make it more prominent. It now looks like: Related Issue(s): ... Proposed changes:
Pre-flight checklist
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢
* Split contributor's and reviewer's checklists * contributor-centric checklist * Move issues at the top and split entry * phrasing
Problem:
Solution:
Contributor's Checklist:
Reviewer's Checklist: