mirror of
https://github.com/MillironX/nf-core_modules.git
synced 2024-12-22 11:08:17 +00:00
fix: add guidelines to PRs and issues
This commit is contained in:
parent
8eb3acc43f
commit
a285bfe8a6
5 changed files with 201 additions and 0 deletions
70
.github/CONTRIBUTING.md
vendored
Normal file
70
.github/CONTRIBUTING.md
vendored
Normal file
|
@ -0,0 +1,70 @@
|
|||
# nf-core/modules: Contributing Guidelines
|
||||
|
||||
Hi there!
|
||||
Many thanks for taking an interest in improving nf-core/modules.
|
||||
|
||||
We try to manage the required tasks for nf-core/modules using GitHub issues, you probably came to this page when creating one.
|
||||
Please use the pre-filled template to save time.
|
||||
|
||||
However, don't be put off by this template - other more general issues and suggestions are welcome!
|
||||
Contributions to the code are even more welcome ;)
|
||||
|
||||
> If you need help using or modifying nf-core/modules then the best place to ask is on the nf-core Slack [#modules](https://nfcore.slack.com/channels/modules) channel ([join our Slack here](https://nf-co.re/join/slack)).
|
||||
|
||||
## Contribution workflow
|
||||
|
||||
If you'd like to write some code for nf-core/modules, the standard workflow is as follows:
|
||||
|
||||
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
|
||||
|
||||
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/).
|
||||
|
||||
## Tests
|
||||
|
||||
When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
|
||||
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.
|
||||
|
||||
### Module tests
|
||||
|
||||
Each `nf-core/module` should be set up with a minimal set of test-data.
|
||||
`GitHub Actions` then runs the module on this data to ensure that it exits successfully.
|
||||
If there are any failures then the automated tests fail.
|
||||
These tests are run both with the latest available version of `Nextflow` and also the minimum required version that is stated in the pipeline code.
|
||||
|
||||
## Patch
|
||||
|
||||
:warning: Only in the unlikely and regretful event of a release happening with a bug.
|
||||
|
||||
* On your own fork, make a new branch `patch` based on `upstream/master`.
|
||||
* Fix the bug, and bump version (X.Y.Z+1).
|
||||
* A PR should be made on `master` from patch to directly this particular bug.
|
||||
|
||||
## Getting help
|
||||
|
||||
For further information/help, please consult the [nf-core/modules README](https://github.com/nf-core/modules) and don't hesitate to get in touch on the nf-core Slack [#modules](https://nfcore.slack.com/channels/modules) channel ([join our Slack here](https://nf-co.re/join/slack)).
|
||||
|
||||
### Software version reporting
|
||||
|
||||
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
|
||||
<YOUR_TOOL> --version &> v_<YOUR_TOOL>.txt 2>&1 || true
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
<YOUR_TOOL> --help | head -n 1 &> v_<YOUR_TOOL>.txt 2>&1 || true
|
||||
```
|
||||
|
||||
### Images and figures
|
||||
|
||||
For overview images and other documents we follow the nf-core [style guidelines and examples](https://nf-co.re/developers/design_guidelines).
|
64
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
64
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Report something that is broken or incorrect
|
||||
title: "[BUG]"
|
||||
---
|
||||
|
||||
<!--
|
||||
# nf-core/module bug report
|
||||
|
||||
Hi there!
|
||||
|
||||
Thanks for telling us about a problem with the modules.
|
||||
Please delete this text and anything that's not relevant from the template below:
|
||||
-->
|
||||
|
||||
## Check Documentation
|
||||
|
||||
I have checked the following places for your error:
|
||||
|
||||
- [ ] [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
|
||||
- [ ] [nf-core/module documentation](https://github.com/nf-core/modules/blob/master/README.md)
|
||||
|
||||
## Description of the bug
|
||||
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
## Steps to reproduce
|
||||
|
||||
Steps to reproduce the behaviour:
|
||||
|
||||
1. Command line: <!-- [e.g. `nextflow run ...`] -->
|
||||
2. See error: <!-- [Please provide your error message] -->
|
||||
|
||||
## Expected behaviour
|
||||
|
||||
<!-- A clear and concise description of what you expected to happen. -->
|
||||
|
||||
## Log files
|
||||
|
||||
Have you provided the following extra information/files:
|
||||
|
||||
- [ ] The command used to run the module
|
||||
- [ ] The `.nextflow.log` file <!-- this is a hidden file in the directory where you launched the module -->
|
||||
|
||||
## System
|
||||
|
||||
- Hardware: <!-- [e.g. HPC, Desktop, Cloud...] -->
|
||||
- Executor: <!-- [e.g. slurm, local, awsbatch...] -->
|
||||
- OS: <!-- [e.g. CentOS Linux, macOS, Linux Mint...] -->
|
||||
- Version <!-- [e.g. 7, 10.13.6, 18.3...] -->
|
||||
|
||||
## Nextflow Installation
|
||||
|
||||
- Version: <!-- [e.g. 19.10.0] -->
|
||||
|
||||
## Container engine
|
||||
|
||||
- Engine: <!-- [e.g. Conda, Docker, Singularity or Podman] -->
|
||||
- version: <!-- [e.g. 1.0.0] -->
|
||||
- Image tag: <!-- [e.g. nfcore/module:2.6] -->
|
||||
|
||||
## Additional context
|
||||
|
||||
<!-- Add any other context about the problem here. -->
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,8 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Join nf-core
|
||||
url: https://nf-co.re/join
|
||||
about: Please join the nf-core community here
|
||||
- name: "Slack #modules channel"
|
||||
url: https://nfcore.slack.com/channels/modules
|
||||
about: Discussion about nf-core/modules
|
32
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
32
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for nf-core/modules
|
||||
title: "[FEATURE]"
|
||||
---
|
||||
|
||||
<!--
|
||||
# nf-core/modules feature request
|
||||
|
||||
Hi there!
|
||||
|
||||
Thanks for suggesting a new feature for the modules!
|
||||
Please delete this text and anything that's not relevant from the template below:
|
||||
-->
|
||||
|
||||
## Is your feature request related to a problem? Please describe
|
||||
|
||||
<!-- A clear and concise description of what the problem is. -->
|
||||
|
||||
<!-- e.g. [I'm always frustrated when ...] -->
|
||||
|
||||
## Describe the solution you'd like
|
||||
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
## Describe alternatives you've considered
|
||||
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
## Additional context
|
||||
|
||||
<!-- Add any other context about the feature request here. -->
|
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,27 @@
|
|||
<!--
|
||||
# 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
|
||||
|
||||
- [ ] 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 `<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`)
|
Loading…
Reference in a new issue