You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+80-12
Original file line number
Diff line number
Diff line change
@@ -9,35 +9,42 @@ Please use the pre-filled template to save time.
9
9
However, don't be put off by this template - other more general issues and suggestions are welcome!
10
10
Contributions to the code are even more welcome ;)
11
11
12
+
> [!NOTE]
12
13
> If you need help using or modifying nf-core/phaseimpute then the best place to ask is on the nf-core Slack [#phaseimpute](https://nfcore.slack.com/channels/phaseimpute) channel ([join our Slack here](https://nf-co.re/join/slack)).
13
14
14
15
## Contribution workflow
15
16
16
17
If you'd like to write some code for nf-core/phaseimpute, the standard workflow is as follows:
17
18
18
-
1. Check that there isn't already an issue about your idea in the [nf-core/phaseimpute issues](https://github.com/nf-core/phaseimpute/issues) to avoid duplicating work
19
-
* If there isn't one already, please create one so that others know you're working on this
19
+
1. Check that there isn't already an issue about your idea in the [nf-core/phaseimpute issues](https://github.com/nf-core/phaseimpute/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this
20
20
2.[Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/phaseimpute repository](https://github.com/nf-core/phaseimpute) to your GitHub account
21
-
3. Make the necessary changes / additions within your forked repository
22
-
4. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged
21
+
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
22
+
4. Use `nf-core pipelines schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
23
+
5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged
23
24
24
25
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/).
25
26
26
27
## Tests
27
28
29
+
You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. Execute all the tests with the following command:
30
+
31
+
```bash
32
+
nf-test test --profile debug,test,docker --verbose
33
+
```
34
+
28
35
When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
29
36
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.
30
37
31
38
There are typically two types of tests that run:
32
39
33
-
### Lint Tests
40
+
### Lint tests
34
41
35
42
`nf-core` has a [set of guidelines](https://nf-co.re/developers/guidelines) which all pipelines must adhere to.
36
-
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core lint <pipeline-directory>` command.
43
+
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core pipelines lint <pipeline-directory>` command.
37
44
38
45
If any failures or warnings are encountered, please follow the listed URL for more documentation.
39
46
40
-
### Pipeline Tests
47
+
### Pipeline tests
41
48
42
49
Each `nf-core` pipeline should be set up with a minimal set of test-data.
43
50
`GitHub Actions` then runs the pipeline on this data to ensure that it exits successfully.
@@ -46,12 +53,73 @@ These tests are run both with the latest available version of `Nextflow` and als
46
53
47
54
## Patch
48
55
49
-
:warning: Only in the unlikely and regretful event of a release happening with a bug.
56
+
:warning: Only in the unlikely and regretful event of a release happening with a bug.
50
57
51
-
* On your own fork, make a new branch `patch` based on `upstream/master`.
52
-
* Fix the bug, and bump version (X.Y.Z+1).
53
-
* A PR should be made on `master` from patch to directly this particular bug.
58
+
- On your own fork, make a new branch `patch` based on `upstream/master`.
59
+
- Fix the bug, and bump version (X.Y.Z+1).
60
+
- A PR should be made on `master` from patch to directly this particular bug.
54
61
55
62
## Getting help
56
63
57
-
For further information/help, please consult the [nf-core/phaseimpute documentation](https://nf-co.re/nf-core/phaseimpute/docs) and don't hesitate to get in touch on the nf-core Slack [#phaseimpute](https://nfcore.slack.com/channels/phaseimpute) channel ([join our Slack here](https://nf-co.re/join/slack)).
64
+
For further information/help, please consult the [nf-core/phaseimpute documentation](https://nf-co.re/phaseimpute/usage) and don't hesitate to get in touch on the nf-core Slack [#phaseimpute](https://nfcore.slack.com/channels/phaseimpute) channel ([join our Slack here](https://nf-co.re/join/slack)).
65
+
66
+
## Pipeline contribution conventions
67
+
68
+
To make the nf-core/phaseimpute code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.
69
+
70
+
### Adding a new step
71
+
72
+
If you wish to contribute a new step, please use the following coding standards:
73
+
74
+
1. Define the corresponding input channel into your new process from the expected previous process channel
75
+
2. Write the process block (see below).
76
+
3. Define the output channel if needed (see below).
77
+
4. Add any new parameters to `nextflow.config` with a default (see below).
78
+
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool).
79
+
6. Add sanity checks and validation for all relevant parameters.
80
+
7. Perform local tests to validate that the new code works as expected.
81
+
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
82
+
9. Update MultiQC config `assets/multiqc_config.yml` so relevant suffixes, file name clean up and module plots are in the appropriate order. If applicable, add a [MultiQC](https://https://multiqc.info/) module.
83
+
10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.
84
+
85
+
### Default values
86
+
87
+
Parameters should be initialised / defined with default values in `nextflow.config` under the `params` scope.
88
+
89
+
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.
90
+
91
+
### Default processes resource requirements
92
+
93
+
Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.
94
+
95
+
The process resources can be passed on to the tool dynamically within the process with the `${task.cpus}` and `${task.memory}` variables in the `script:` block.
96
+
97
+
### Naming schemes
98
+
99
+
Please use the following naming schemes, to make it easy to understand what is going where.
100
+
101
+
- initial process channel: `ch_output_from_<process>`
102
+
- intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
103
+
104
+
### Nextflow version bumping
105
+
106
+
If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core pipelines bump-version --nextflow . [min-nf-version]`
107
+
108
+
### Images and figures
109
+
110
+
For overview images and other documents we follow the nf-core [style guidelines and examples](https://nf-co.re/developers/design_guidelines).
111
+
112
+
## GitHub Codespaces
113
+
114
+
This repo includes a devcontainer configuration which will create a GitHub Codespaces for Nextflow development! This is an online developer environment that runs in your browser, complete with VSCode and a terminal.
115
+
116
+
To get started:
117
+
118
+
- Open the repo in [Codespaces](https://github.com/nf-core/phaseimpute/codespaces)
description: A clear and concise description of what the bug is.
18
+
validations:
19
+
required: true
20
+
21
+
- type: textarea
22
+
id: command_used
23
+
attributes:
24
+
label: Command used and terminal output
25
+
description: Steps to reproduce the behaviour. Please paste the command you used to launch the pipeline and the output from your terminal.
26
+
render: console
27
+
placeholder: |
28
+
$ nextflow run ...
29
+
30
+
Some output where something broke
31
+
32
+
- type: textarea
33
+
id: files
34
+
attributes:
35
+
label: Relevant files
36
+
description: |
37
+
Please drag and drop the relevant files here. Create a `.zip` archive if the extension is not allowed.
38
+
Your verbose log file `.nextflow.log` is often useful _(this is a hidden file in the directory where you launched the pipeline)_ as well as custom Nextflow configuration files.
description: Suggest an idea for the nf-core/phaseimpute pipeline
3
+
labels: enhancement
4
+
body:
5
+
- type: textarea
6
+
id: description
7
+
attributes:
8
+
label: Description of feature
9
+
description: Please describe your suggestion for a new feature. It might help to describe a problem or use case, plus any alternatives that you have considered.
Many thanks for contributing to nf-core/phaseimpute!
4
5
5
6
Please fill in the appropriate checklist below (delete whatever is not relevant).
6
7
These are the most common things requested on pull requests (PRs).
7
8
9
+
Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.
10
+
11
+
Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/phaseimpute/tree/master/.github/CONTRIBUTING.md)
12
+
-->
13
+
8
14
## PR checklist
9
15
10
-
-[ ] This comment contains a description of changes (with reason)
16
+
-[ ] This comment contains a description of changes (with reason).
11
17
-[ ] If you've fixed a bug or added code that should be tested, add tests!
12
-
-[ ] If necessary, also make a PR on the [nf-core/phaseimpute branch on the nf-core/test-datasets repo](https://github.com/nf-core/test-datasets/pull/new/nf-core/phaseimpute)
13
-
-[ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
14
-
-[ ] Make sure your code lints (`nf-core lint .`).
15
-
-[ ] Documentation in `docs` is updated
16
-
-[ ]`CHANGELOG.md` is updated
17
-
-[ ]`README.md` is updated
18
-
19
-
**Learn more about contributing:**[CONTRIBUTING.md](https://github.com/nf-core/phaseimpute/tree/master/.github/CONTRIBUTING.md)
18
+
-[ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/phaseimpute/tree/master/.github/CONTRIBUTING.md)
19
+
-[ ] If necessary, also make a PR on the nf-core/phaseimpute _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
20
+
-[ ] Make sure your code lints (`nf-core pipelines lint`).
21
+
-[ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
22
+
-[ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
23
+
-[ ] Usage Documentation in `docs/usage.md` is updated.
24
+
-[ ] Output Documentation in `docs/output.md` is updated.
25
+
-[ ]`CHANGELOG.md` is updated.
26
+
-[ ]`README.md` is updated (including new tool citations and authors/contributors).
0 commit comments