diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 71e00464..4c71e0df 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,37 +1,43 @@ -> This is a template for UCLA-CDS pipeline developers to create a github pull request template. Things should be adjusted for individual pipeline including: -> 1. additional checklist items sepecific to the pipeline -> 2. a description of how testing is expected to be done -> 3. a template list or table for testing results -> 4. additional notes wrapped in \ (or \ + ### Closes #... ## Testing Results -- Case 1 - - sample: - - input csv: - - config: - - output: -- Case 2 - - sample: - - input csv: - - config: - - output: + + +- NFTest + - log: /hot/software/pipeline/pipeline-recalibrate-BAM/Nextflow/development/unreleased/\/log-nftest-\.log + - cases: default set + + +- Additional Case 1 + - sample: + - input csv: + - config: + - output: # Checklist - + - [ ] I have read the [code review guidelines](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3187646/Code+Review+Guidelines) and the [code review best practice on GitHub check-list](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3189956/Code+Review+Best+Practice+on+GitHub+-+Check+List). - [ ] I have reviewed the [Nextflow pipeline standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3193890/Nextflow+pipeline+standardization). -- [ ] The name of the branch is meaningful and well formatted following the [standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3189956/Code+Review+Best+Practice+on+GitHub+-+Check+List), using \[AD_username (or 5 letters of AD if AD is too long)]-\[brief_description_of_branch]. +- [ ] The name of the branch is meaningful and well formatted following the [standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3189956/Code+Review+Best+Practice+on+GitHub+-+Check+List), using \[AD\_username (or 5 letters of AD if AD is too long)]-\[brief\_description\_of\_branch\]. - [ ] I have set up or verified the branch protection rule following the [github standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3190380/GitHub+Standards#GitHubStandards-Branchprotectionrule) before opening this pull request. @@ -42,4 +48,4 @@ already, or do not wish to be listed. (*This acknowledgement is optional.*) - [ ] I have updated the version number in the `metadata.yaml` and `manifest` block of the `nextflow.config` file following [semver](https://semver.org/), or the version number has already been updated. (*Leave it unchecked if you are unsure about new version number and discuss it with the infrastructure team in this PR.*) -- [ ] I have tested the pipeline on at least one A-mini sample. +- [ ] I have tested the pipeline using NFTest, _or_ I have justified why I did not need to run NFTest above.