Overview

The steps covered in this tutorial are:

1. Introduction (this page!)
2. Create a pipeline
3. Running with test data
4. Adding to the nf-core organisation
5. Making your first release
6. Next steps

Before you start

So, you want to add a new pipeline to nf-core - brilliant! Before you start typing, check that you’re happy with the following points:

• You’re familiar with nf-core and nextflow (see our introduction docs).
• You’re used to working with git and GitHub (see a nice tutorial here)
• The workflow you’re thinking of meets the nf-core guidelines.

Join the community

At its heart, nf-core is a community - to add a pipeline you need to be part of that community! Please join us on Slack, and ask to be added to the GitHub association through the #github-invitations channel. If you feel like it, you can go to the #say-hello channel and introduce yourself to the rest of the community.

The nf-core guidelines state that no two pipelines should overlap too much in their purpose and results. There may be an existing pipeline that can be extended to give the functionality that you are looking for, or there could be another group working on a similar to the pipeline to the one you’re planning.

To avoid problems at a later date, please come and discuss your plans with the nf-core community as early as possible. Ideally before you make a start on your pipeline!

All nf-core discussion happens on the nf-core Slack, which you can join here: https://nf-co.re/join

These topics are specifically discussed in the nf-core/proposals repository.