nf-core_modules/.github/PULL_REQUEST_TEMPLATE.md
2021-02-16 13:59:21 +01:00

1.4 KiB

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the <SOFTWARE>.version.txt file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works (PROFILE=docker pytest --tag <MODULE> --symlink --wt 2 --keep-workflow-wd)
  • Ensure that the test works (PROFILE=singularity pytest --tag <MODULE> --symlink --wt 2 --keep-workflow-wd)
  • Ensure that the test works (PROFILE=conda pytest --tag <MODULE> --symlink --wt 2 --keep-workflow-wd)