millironx/nf-core_modules
1
0
Fork 0
mirror of https://github.com/MillironX/nf-core_modules.git synced 2024-12-22 19:18:17 +00:00
Code Issues Releases Packages Activity

fix: add suggestions from reviews

Browse source
This commit is contained in:
MaxUlysse 2021-02-16 13:59:21 +01:00
parent a285bfe8a6
commit bbee0efd75
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.github/CONTRIBUTING.md vendored
View file

@ -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 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 * 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 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) 3. When adding a module file, follow the [guidelines](https://github.com/nf-core/modules#adding-a-new-module-file)
4. 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. 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
6. Submit a Pull Request against the `dev` 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/). 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: Add to the script block of the process, something like the following:
```bash ```bash
<YOUR_TOOL> --version &> v_<YOUR_TOOL>.txt 2>&1 || true <YOUR_TOOL> --version &> v_<YOUR_TOOL>.txt 2>&1
``` ```
or or
```bash ```bash
<YOUR_TOOL> --help | head -n 1 &> v_<YOUR_TOOL>.txt 2>&1 || true <YOUR_TOOL> --help | head -n 1 &> v_<YOUR_TOOL>.txt 2>&1
``` ```
### Images and figures ### Images and figures

6
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -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). - [ ] 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 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 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 necessary, include test data in your PR.
- [ ] Remove all TODO statements. - [ ] Remove all TODO statements.
- [ ] Emit the `<SOFTWARE>.version.txt` file. - [ ] Emit the `<SOFTWARE>.version.txt` file.
- [ ] Follow the naming conventions. - [ ] Follow the naming conventions.
@ -25,3 +25,5 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/modu
- [ ] Add a resource `label` - [ ] Add a resource `label`
- [ ] Use BioConda and BioContainers if possible to fulfil software requirements. - [ ] 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=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`)