Skip to content

Commit 3565af5

Browse files
nf-core lint output
1 parent fdf5379 commit 3565af5

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Contributions to the code are even more welcome ;)
1515

1616
If you'd like to write some code for nf-core/rnaseq, the standard workflow is as follows:
1717

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
2019
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
2120
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
2221
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
4948

5049
:warning: Only in the unlikely and regretful event of a release happening with a bug.
5150

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.
5554

5655
## Getting help
5756

@@ -73,7 +72,7 @@ If you wish to contribute a new step, please use the following coding standards:
7372
6. Add sanity checks and validation for all relevant parameters.
7473
7. Perform local tests to validate that the new code works as expected.
7574
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.
7776
10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.
7877

7978
### Default values
@@ -92,8 +91,8 @@ The process resources can be passed on to the tool dynamically within the proces
9291

9392
Please use the following naming schemes, to make it easy to understand what is going where.
9493

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>`
9796

9897
### Nextflow version bumping
9998

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The nf-core/rnaseq documentation is split into the following pages:
44

5-
* [Usage](usage.md)
6-
* An overview of how the pipeline works, how to run it and a description of all of the different command-line flags.
7-
* [Output](output.md)
8-
* An overview of the different results produced by the pipeline and how to interpret them.
5+
- [Usage](usage.md)
6+
- An overview of how the pipeline works, how to run it and a description of all of the different command-line flags.
7+
- [Output](output.md)
8+
- An overview of the different results produced by the pipeline and how to interpret them.
99

1010
You can find a lot more documentation about installing, configuring and running nf-core pipelines on the website: [https://nf-co.re](https://nf-co.re)

0 commit comments

Comments
 (0)