diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 268bd97..5f12f44 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,56 +1,61 @@ -## Description +# Description + - +### Closes #... - -## Checklist +## Testing Results -### Formatting +### Docker Image Testing -- [ ] I have read the [code review guidelines](https://confluence.mednet.ucla.edu/display/BOUTROSLAB/Code+Review+Guidelines) and the [code review best practice on GitHub check-list](https://confluence.mednet.ucla.edu/display/BOUTROSLAB/Code+Review+Best+Practice+on+GitHub+-+Check+List). +- [ ] I have tested the Docker image with the `docker run` command as described below. -- [ ] The name of the branch is meaningful and well formatted following the [standards](https://confluence.mednet.ucla.edu/display/BOUTROSLAB/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]. +#### Test the Docker image with at least one sample. Verify the new Docker image works using: -- [ ] I have set up or verified the branch protection rule following the [github standards](https://confluence.mednet.ucla.edu/pages/viewpage.action?spaceKey=BOUTROSLAB&title=GitHub+Standards#GitHubStandards-Branchprotectionrule) before opening this pull request. +```docker run -u $(id -u):$(id -g) –w -v : --rm ``` -### File Updates +#### My command: -- [ ] I have updated the version number/dependencies and added my name to the maintainer listing in the `Dockerfile`. +```Provide the command you ran here``` -- [ ] I have updated the version number/feature changes in the `README.md`. +### Test Cases - -- [ ] I have updated the version number and added my name to the contributors listing in the `metadata.yaml`. +- Case 1 + - sample: + - input csv: + - config: + - output: +- Case 2 + - sample: + - input csv: + - config: + - output: + +# Checklist + -- [ ] I have added the changes included in this pull request to the `CHANGELOG.md` under the next release version or unreleased, and updated the date. +### Formatting - -- [ ] I have drafted the new version release with any addidtions/changes and have linked the `CHANGELOG.md` in the release. +- [ ] 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). -### Docker Hub Auto Build Rules +- [ ] 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 created automated build rules following [this page](https://confluence.mednet.ucla.edu/display/BOUTROSLAB/How+to+set+up+automated+builds+for+Docker+Hub) and I have not manually pushed this Docker image to the `blcdsdockerregistry` on [Docker Hub](https://hub.docker.com). +- [ ] 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. -### Docker Image Testing +### File Updates -- [ ] I have tested the Docker image with the `docker run` command as described below. +- [ ] I have ensured that the version number update follows the [versioning standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3188472/Docker+image+versioning+standardization). -Test the Docker image with at least one A-mini sample. Verify the new Docker image works using: +- [ ] I have updated the version number in the `Dockerfile`, `README.md` and `metadata.yaml` files. -```docker run -u $(id -u):$(id -g) –w -v : --rm ``` +- [ ] I have updated the dependencies and added my name to the maintainer list in the `Dockerfile`. -My command: +- [ ] I have updated the feature changes in the `README.md` (optional). -```Provide the command you ran here``` - - - -## Testing Results +- [ ] I have added the changes included in this pull request to the `CHANGELOG.md` under the next release version or unreleased, and updated the date. -Closes # +### GitHub Packages Auto Build Rules -- Case 1 - - sample: - - input files: - - config: - - output: +- [ ] I have not manually pushed this Docker image to the uclahs-cds container registry (`ghcr.io/uclahs-cds`) on [GitHub](https://github.com/orgs/uclahs-cds/packages). + +- [ ] **I have updated the `image_name`** in the `metadata.yaml` which is required by GitHub action to automatically build and push the image.