-
Notifications
You must be signed in to change notification settings - Fork 2
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 PR template to be more comprehensive and usable #231
base: develop
Are you sure you want to change the base?
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 Kellie! some super minor comments from me
Co-authored-by: Bryan Mayer <39173901+mayerbry@users.noreply.github.com>
Co-authored-by: Bryan Mayer <39173901+mayerbry@users.noreply.github.com>
Co-authored-by: Bryan Mayer <39173901+mayerbry@users.noreply.github.com>
@kelliemac The main thing I would love to see is more / better instructions to the reviewer about what specifically to review. I know it's already stated, but often forgotten! Something like (highlighted in bold italics for your review): Here, describe your changes in detail and provide instruction to the reviewer on areas on which you'd like them to focus. Give a short background on the report, outline important questions or details for the reviewer, and add links to any supporting documents (e.g., protocol presentation). It's helpful to add links to the key files with the unique ID for the commit (a.k.a. the "SHA" or "hash"). |
@asatofh I added a section specifically with a checklist for the reviewer. let me know what you think! |
note to self: need to confirm that this PR template is correctly used in new analysis repos. consider manually copying to pre-made analysis repos when ready as well. |
Description
Updates PR template to be more comprehensive and better organized, so that people are reminded "just-in-time" of the key steps they should be taking before each submitting a PR for review (within an analysis repo).
In particular:
Related Issues
Related to #228 and in some sense also #119 and #181
Checklist
devtools::document