FredHutch / VISCtemplates

Tools for writing reproducible reports at VISC
Other
6 stars 2 forks source link

Update PR template to be more comprehensive and usable #231

Open kelliemac opened 2 weeks ago

kelliemac commented 2 weeks ago

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 https://github.com/FredHutch/VISCtemplates/issues/228 and in some sense also https://github.com/FredHutch/VISCtemplates/issues/119 and https://github.com/FredHutch/VISCtemplates/issues/181

Checklist

kelliemac commented 2 weeks ago

@asatofh and @mayerbry I took a stab at updating the analysis repo PR template to be more in line with the actual workflow I use and tasks I know need to be addressed. hoping this will help the PR process become a little smoother for both PR creators and reviewers. any feedback is welcome!!!

kelliemac commented 2 weeks ago

thanks @mayerbry! I incorporated all your suggestions. @asatofh do you want to take a look too, or are you happy for me to merge this PR?

asatofh commented 2 weeks ago

thanks @mayerbry! I incorporated all your suggestions. @asatofh do you want to take a look too, or are you happy for me to merge this PR?

@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").

kelliemac commented 1 week ago

thanks @mayerbry! I incorporated all your suggestions. @asatofh do you want to take a look too, or are you happy for me to merge this PR?

@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!

kelliemac commented 1 week ago

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.