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
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,8 +15,7 @@ Contributions to the code are even more welcome ;)
15
15
16
16
If you'd like to write some code for nf-core/rnaseq, the standard workflow is as follows:
17
17
18
-
1. Check that there isn't already an issue about your idea in the [nf-core/rnaseq issues](https://github.com/nf-core/rnaseq/issues) to avoid duplicating work
19
-
* If there isn't one already, please create one so that others know you're working on this
18
+
1. Check that there isn't already an issue about your idea in the [nf-core/rnaseq issues](https://github.com/nf-core/rnaseq/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this
20
19
2.[Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/rnaseq repository](https://github.com/nf-core/rnaseq) to your GitHub account
21
20
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
22
21
4. Use `nf-core schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
@@ -49,9 +48,9 @@ These tests are run both with the latest available version of `Nextflow` and als
49
48
50
49
:warning: Only in the unlikely and regretful event of a release happening with a bug.
51
50
52
-
* On your own fork, make a new branch `patch` based on `upstream/master`.
53
-
* Fix the bug, and bump version (X.Y.Z+1).
54
-
* A PR should be made on `master` from patch to directly this particular bug.
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.
55
54
56
55
## Getting help
57
56
@@ -73,7 +72,7 @@ If you wish to contribute a new step, please use the following coding standards:
73
72
6. Add sanity checks and validation for all relevant parameters.
74
73
7. Perform local tests to validate that the new code works as expected.
75
74
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
76
-
9. Update MultiQC config `assets/multiqc_config.yaml` 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.
75
+
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.
77
76
10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.
78
77
79
78
### Default values
@@ -92,8 +91,8 @@ The process resources can be passed on to the tool dynamically within the proces
92
91
93
92
Please use the following naming schemes, to make it easy to understand what is going where.
94
93
95
-
* initial process channel: `ch_output_from_<process>`
96
-
* intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
94
+
- initial process channel: `ch_output_from_<process>`
95
+
- intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
0 commit comments