uclahs-cds / pipeline-recalibrate-BAM

Nextflow pipeline to perform Indel Realignment and Base Quality Score Recalibration
https://uclahs-cds.github.io/pipeline-recalibrate-BAM/
GNU General Public License v2.0
1 stars 1 forks source link

Update PR template #37

Closed nwiltsie closed 11 months ago

nwiltsie commented 11 months ago

This updates and fills in the templated parts of the pull request template.

In addition to removing the template text and cleaning up a few markdown quirks, I overhauled the Testing Results section. My impression is that users (myself included) almost never completely fill out the existing "Case 1: sample, input csv, ..." table (if we do at all). I switched instead to "requiring" the path to and the last few lines of the NFTest log file, or a justification of why testing isn't required (for example, this PR doesn't require testing because it's a documentation-only change). If/when anyone cares to go digging, the NFTest logfile has the details of the test run and is stored adjacent to the output files themselves.

This is functionally identical to what I wrote up for #36, and I think it's simultaneously more informative and more usable, but I welcome any feedback on it! If everyone likes it I think this (or something like it) could be a good template to apply to other repos making use of NFTest.

Checklist

yashpatel6 commented 11 months ago

@uclahs-cds/nextflow-wg Any comments/suggestions for the PR template here?