feature: add new issue template for creating new module (#283)

* feature: add new issue template for creating new module

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Kevin Menden <kevin.menden@live.com>

Co-authored-by: Kevin Menden <kevin.menden@live.com>
This commit is contained in:
Maxime Garcia 2021-03-19 15:39:22 +01:00 committed by GitHub
parent 8a44258548
commit e61f400167
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 2 deletions

26
.github/ISSUE_TEMPLATE/new_module.md vendored Normal file
View file

@ -0,0 +1,26 @@
---
name: New module
about: Suggest a new module for nf-core/modules
title: "new module: TOOL/SUBTOOL"
label: new module
---
<!--
# nf-core/modules new module suggestion
Hi there!
Thanks for suggesting a new module for the modules!
Please delete this text and anything that's not relevant from the template below:
Replace TOOL with the bioconda name for the tool in the following text, so that the link is functional.
Replace TOOL/SUBTOOL in the issue title so that it's understandable.
-->
I think it would be good to have a module for [TOOL](https://bioconda.github.io/recipes/TOOL/README.html)
- [ ] This module does not exist yet with the [`nf-core modules list`](https://github.com/nf-core/tools#list-modules) command
- [ ] There is no [open pull request](https://github.com/nf-core/modules/pulls) for this module
- [ ] There is no [open issue](https://github.com/nf-core/modules/issues) for this module
- [ ] If I'm planning to work on this module, I added myself to the `Assignees` to facilitate tracking who is working on the module

View file

@ -157,10 +157,9 @@ Please check that the module you wish to add isn't already on [`nf-core/modules`
- Search [open issues](https://github.com/nf-core/modules/issues) - Search [open issues](https://github.com/nf-core/modules/issues)
If the module doesn't exist on `nf-core/modules`: If the module doesn't exist on `nf-core/modules`:
- Please create a [new issue](https://github.com/nf-core/modules/issues/new/choose) before adding it - Please create a [new issue](https://github.com/nf-core/modules/issues/new?assignees=&labels=new%20module&template=new_nodule.md&title=new%20module:) before adding it
- Set an appropriate subject for the issue e.g. `new module: fastqc` - Set an appropriate subject for the issue e.g. `new module: fastqc`
- Add yourself to the `Assignees` so we can track who is working on the module - Add yourself to the `Assignees` so we can track who is working on the module
- Set the appropriate `Labels` for the issue e.g. `new module`
### nf-core modules create ### nf-core modules create