nf-core_modules/.github/PULL_REQUEST_TEMPLATE.md

<!--
# nf-core/modules pull request

Many thanks for contributing to nf-core/modules!

Please fill in the appropriate checklist below (delete whatever is not relevant).
These are the most common things requested on pull requests (PRs).

Remember that PRs should be made against the master branch.

Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/modules/tree/master/.github/CONTRIBUTING.md)
-->

## PR checklist

Closes #XXX <!-- If this PR fixes an issue, please link it here! -->

- [ ] 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](https://github.com/nf-core/modules/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, include test data in your PR.
- [ ] Remove all TODO statements.
- [ ] Emit the `versions.yml` 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 with either Docker / Singularity. Conda CI tests can be quite flaky:
    - [ ] `PROFILE=docker pytest --tag <MODULE> --symlink --keep-workflow-wd`
    - [ ] `PROFILE=singularity pytest --tag <MODULE> --symlink --keep-workflow-wd`
    - [ ] `PROFILE=conda pytest --tag <MODULE> --symlink --keep-workflow-wd`
fix: add guidelines to PRs and issues 2021-02-16 10:07:43 +00:00			`<!--`
			`# nf-core/modules pull request`

			`Many thanks for contributing to nf-core/modules!`

			`Please fill in the appropriate checklist below (delete whatever is not relevant).`
			`These are the most common things requested on pull requests (PRs).`

			`Remember that PRs should be made against the master branch.`

			`Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/modules/tree/master/.github/CONTRIBUTING.md)`
			`-->`

			`## PR checklist`

Add link to issue in pull request template (#312) * Add link to issue in pull request template * Update PULL_REQUEST_TEMPLATE.md 2021-03-22 17:04:20 +00:00			`Closes #XXX <!-- If this PR fixes an issue, please link it here! -->`

fix: add guidelines to PRs and issues 2021-02-16 10:07:43 +00:00			`- [ ] This comment contains a description of changes (with reason).`
			`- [ ] If you've fixed a bug or added code that should be tested, add tests!`
fix: add suggestions from reviews 2021-02-16 12:59:21 +00:00			`- [ ] If you've added a new tool - have you followed the module conventions in the [contribution docs](https://github.com/nf-core/modules/tree/master/.github/CONTRIBUTING.md)`
			`- [ ] If necessary, include test data in your PR.`
fix: add guidelines to PRs and issues 2021-02-16 10:07:43 +00:00			`- [ ] Remove all TODO statements.`
Update fastqc to produce multi-version versions.yml (#665) * Update fastqc to produce multi-version versions.yml * Update readme and pull request template * Fix markdownlint * remove variable * Change publish dir to lowercase * Re-add getSoftwareName * Add custom pytest-workflow test to ensure versions.yml is valid * Add docstring * Remove __init__.py as it is not needed * Remove changes to README, since this part went to nf-co.re * Add NF_CORE_TEST env var * Fix editorconfig * Add additional consistency checks for versions.yml * Update multiqc module * Fix output channel 2021-09-24 09:01:54 +00:00			- [ ] Emit the `versions.yml` file.
fix: add guidelines to PRs and issues 2021-02-16 10:07:43 +00:00			`- [ ] 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.`
fix: Apply suggestions from code review 2021-02-16 23:34:55 +00:00			`- Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:`
Only use one thread for pytest-workflow This avoids a race condition on the conda cache. 2021-02-23 13:06:52 +00:00			- [ ] `PROFILE=docker pytest --tag <MODULE> --symlink --keep-workflow-wd`
			- [ ] `PROFILE=singularity pytest --tag <MODULE> --symlink --keep-workflow-wd`
			- [ ] `PROFILE=conda pytest --tag <MODULE> --symlink --keep-workflow-wd`