|
1 | | -# nf-core/fetchngs: Contributing Guidelines |
| 1 | +# `nf-core/fetchngs`: Contributing Guidelines |
2 | 2 |
|
3 | 3 | Hi there! |
4 | 4 | Many thanks for taking an interest in improving nf-core/fetchngs. |
@@ -55,36 +55,34 @@ These tests are run both with the latest available version of `Nextflow` and als |
55 | 55 |
|
56 | 56 | :warning: Only in the unlikely and regretful event of a release happening with a bug. |
57 | 57 |
|
58 | | -- On your own fork, make a new branch `patch` based on `upstream/master`. |
| 58 | +- On your own fork, make a new branch `patch` based on `upstream/main` or `upstream/master`. |
59 | 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. |
| 60 | +- Open a pull-request from `patch` to `main`/`master` with the changes. |
61 | 61 |
|
62 | 62 | ## Getting help |
63 | 63 |
|
64 | 64 | For further information/help, please consult the [nf-core/fetchngs documentation](https://nf-co.re/fetchngs/usage) and don't hesitate to get in touch on the nf-core Slack [#fetchngs](https://nfcore.slack.com/channels/fetchngs) channel ([join our Slack here](https://nf-co.re/join/slack)). |
65 | 65 |
|
66 | 66 | ## Pipeline contribution conventions |
67 | 67 |
|
68 | | -To make the nf-core/fetchngs 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. |
| 68 | +To make the `nf-core/fetchngs` 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 | 69 |
|
70 | 70 | ### Adding a new step |
71 | 71 |
|
72 | 72 | If you wish to contribute a new step, please use the following coding standards: |
73 | 73 |
|
74 | | -1. Define the corresponding input channel into your new process from the expected previous process channel |
| 74 | +1. Define the corresponding input channel into your new process from the expected previous process channel. |
75 | 75 | 2. Write the process block (see below). |
76 | 76 | 3. Define the output channel if needed (see below). |
77 | 77 | 4. Add any new parameters to `nextflow.config` with a default (see below). |
78 | 78 | 5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool). |
79 | 79 | 6. Add sanity checks and validation for all relevant parameters. |
80 | 80 | 7. Perform local tests to validate that the new code works as expected. |
81 | 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 | 82 |
|
85 | 83 | ### Default values |
86 | 84 |
|
87 | | -Parameters should be initialised / defined with default values in `nextflow.config` under the `params` scope. |
| 85 | +Parameters should be initialised / defined with default values within the `params` scope in `nextflow.config`. |
88 | 86 |
|
89 | 87 | Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`. |
90 | 88 |
|
|
0 commit comments