Skip to content

Commit 771821f

Browse files
authored
Update README.md
1 parent 1eeb9c9 commit 771821f

1 file changed

Lines changed: 29 additions & 3 deletions

File tree

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,10 @@ Currently documentation is available for the following systems:
233233

234234
### Uploading to `nf-core/configs`
235235

236+
> [!WARNING]
237+
> Before you start, make sure you are a part of the nf-core GitHub organisation!
238+
> More information on joining can be found [here](https://nf-co.re/join).
239+
236240
[Fork](https://help.github.com/articles/fork-a-repo/) the [`nf-core/configs`](https://github.com/nf-core/configs/) repository to your own GitHub account.
237241
Within the local clone of your fork:
238242

@@ -254,15 +258,26 @@ Commit and push these changes to your local clone on GitHub, and then [create a
254258
255259
Please request review from @nf-core/maintainers and/or on #request-review on the nf-core slack, and providing that everything adheres to nf-core guidelines we will endeavour to approve your pull request as soon as possible.
256260
261+
> [!NOTE]
262+
> Once you get approval, you as the pull request author MUST merge the pull request.
263+
> Community members cannot be held responsible for the use config on your infrastructure as they do not have permission to test on your infrastructure, therefore the PR author be the person to merge in the config.
264+
> If you do not see the 'merge' button at the bottom of the PR, ensure you're in nf-core GitHub organisation!
265+
> More information on joining can be found [here](https://nf-co.re/join).
266+
257267
## Adding a new pipeline-specific config
258268

269+
> [!WARNING]
270+
> Before you start, make sure you are a part of the nf-core GitHub organisation!
271+
> More information on joining can be found [here](https://nf-co.re/join).
272+
259273
Sometimes it may be desirable to have configuration options for an institute that are specific to a single nf-core pipeline.
260274
Such options should not be added to the main institutional config, as this will be applied to all pipelines.
261275
Instead, we can create a pipeline-specific institutional config file.
262276

263277
> The following steps are similar to the instructions for standard institutional config, however using `pipeline` variants of folders e.g., `conf/pipeline/` or under `pipeline/`
264278

265-
:warning: Remember to replace the `<PIPELINE>` and `<PROFILE>` placeholders with the pipeline name and profile name in the following examples
279+
>[!WARNING]
280+
> Remember to replace the `<PIPELINE>` and `<PROFILE>` placeholders with the pipeline name and profile name in the following examples
266281

267282
Institutional configs work because the pipeline `nextflow.config` file loads the [`nf-core/configs/nfcore_custom.config` config file](https://github.com/nf-core/configs/blob/master/nfcore_custom.config), which in turn loads the institutional configuration file based on the profile `<PROFILE>` supplied on the command line.
268283

@@ -324,7 +339,9 @@ Currently documentation is available for the following pipeline:
324339

325340
### Enabling pipeline-specific configs within a pipeline
326341

327-
:warning: **This has to be done on a fork of the `nf-core/<PIPELINE>` repository.**
342+
343+
>[!WARNING]
344+
> **This has to be done on a fork of the `nf-core/<PIPELINE>` repository.**
328345

329346
[Fork](https://help.github.com/articles/fork-a-repo/) the `nf-core/<PIPELINE>` repository to your own GitHub account.
330347
Within the local clone of your fork, if not already present, add the following to `nextflow.config` **after** the code that loads the generic nf-core/configs config file:
@@ -344,7 +361,9 @@ We will be notified automatically when you have created your pull request, and p
344361

345362
### Create the pipeline-specific `nf-core/configs` files
346363

347-
:warning: This has to be done on a fork of the [`nf-core/configs`](https://github.com/nf-core/configs/) repository.
364+
365+
>[!WARNING]
366+
> This has to be done on a fork of the [`nf-core/configs`](https://github.com/nf-core/configs/) repository.
348367

349368
[Fork](https://help.github.com/articles/fork-a-repo/) the [`nf-core/configs`](https://github.com/nf-core/configs/) repository to your own GitHub account.
350369
And add or edit the following files in the local clone of your fork.
@@ -376,9 +395,16 @@ Edit this file, and add the new pipeline-specific institutional profile to the l
376395
377396
Commit and push these changes to your local clone on GitHub, and then [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) on the `nf-core/configs` GitHub repo with the appropriate information.
378397
In the pull-request description, add a link to the repository specific pull-request(s) that use this new code.
398+
379399
Please request review from @nf-core/maintainers and/or on #request-review on the nf-core slack, and providing that everything adheres to nf-core guidelines we will endeavour to approve your pull request as soon as possible.
380400
Both PRs will need to be merged at the approximately the same time.
381401
402+
> [!NOTE]
403+
> Once you get approval, you as the pull request author MUST merge the pull request.
404+
> Community members cannot be held responsible for the use config on your infrastructure as they do not have permission to test on your infrastructure, therefore the PR author be the person to merge in the config.
405+
> If you do not see the 'merge' button at the bottom of the PR, ensure you're in nf-core GitHub organisation!
406+
> More information on joining can be found [here](https://nf-co.re/join).
407+
382408
## Help
383409
384410
If you have any questions or issues please send us a message on [Slack](https://nfcore.slack.com/channels/configs).

0 commit comments

Comments
 (0)