From bbee0efd758b7420c418086d6ef41547c204f51d Mon Sep 17 00:00:00 2001 From: MaxUlysse Date: Tue, 16 Feb 2021 13:59:21 +0100 Subject: [PATCH] fix: add suggestions from reviews --- .github/CONTRIBUTING.md | 11 +++++------ .github/PULL_REQUEST_TEMPLATE.md | 6 ++++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index dca78f0f..cb36a9c5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,10 +18,9 @@ If you'd like to write some code for nf-core/modules, the standard workflow is a 1. Check that there isn't already an issue about your idea in the [nf-core/modules issues](https://github.com/nf-core/modules/issues) to avoid duplicating work * If there isn't one already, please create one so that others know you're working on this 2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/modules repository](https://github.com/nf-core/modules) to your GitHub account -3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions) -4. When adding a module file, follow the [guidelines](https://github.com/nf-core/modules#adding-a-new-module-file) -5. Ensure that [tests are working locally](https://github.com/nf-core/modules#running-tests-locally) -6. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged +3. When adding a module file, follow the [guidelines](https://github.com/nf-core/modules#adding-a-new-module-file) +4. Ensure that [tests are working locally](https://github.com/nf-core/modules#running-tests-locally) +5. Submit a Pull Request against the `master` branch and wait for the code to be reviewed and merged If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/). @@ -56,13 +55,13 @@ If you add a new module, please ensure you add the information of the tool. Add to the script block of the process, something like the following: ```bash - --version &> v_.txt 2>&1 || true + --version &> v_.txt 2>&1 ``` or ```bash - --help | head -n 1 &> v_.txt 2>&1 || true + --help | head -n 1 &> v_.txt 2>&1 ``` ### Images and figures diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 61f8f071..94c5bb95 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,8 +15,8 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/modu - [ ] 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. +- [ ] 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 `.version.txt` file. - [ ] Follow the naming conventions. @@ -25,3 +25,5 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/modu - [ ] Add a resource `label` - [ ] Use BioConda and BioContainers if possible to fulfil software requirements. - [ ] Ensure that the test works (`PROFILE=docker pytest --tag --symlink --wt 2 --keep-workflow-wd`) +- [ ] Ensure that the test works (`PROFILE=singularity pytest --tag --symlink --wt 2 --keep-workflow-wd`) +- [ ] Ensure that the test works (`PROFILE=conda pytest --tag --symlink --wt 2 --keep-workflow-wd`)