Guidelines

Overview of sections about Guidelines

This is the overview of the guidelines section.

Guidelines

Regulatory

Components

Documentation

Writing style

External use

Guidance on how to use nf-core code and best practices in non-nf-core pipelines.

Google slides progressbar

Graphic design

Templates, common images, and design-related content for nf-core.

Pull request review

Best practices to review contributions.

Checklists
- Community governance
  - Core team
  - Maintainers team
- Reviews
- Pipeline release
Contributing
- Pipelines
  - Pipeline file structure
- nf-test
  - Assertions
- Components
  - ext.args
  - Meta map
- Website
  - Markdown
- Code editors and styling
Guidelines
- Pipelines
  - Overview
  - Recommendations
    
    Bioconda
    Build with community
    Cloud compatible
    DOIs
    File formats
    Publication credit
    Testing
  - Requirements
    
    Acknowledgements
    CI testing
    Community owned
    Docker
    Docs
    Git branches
    Identity branding
    Keywords
    Linting
    Minimum inputs
    MIT license
    Nextflow
    Parameters
    Semantic versioning
    Single command
    Use the template
    Workflow name
    Workflow size
    Workflow specificity
- Regulatory
  - Overview
  - Checklist
- Components
- Documentation
  - Writing style
- External use
- Google slides progressbar
- Graphic design
- Pull request review
nf-core/tools
- Installation
- Pipelines
- Modules
- Subworkflows
- TUI
- Custom remotes
- API Reference
Tutorials
- Use nf-core pipelines
  - Writing institutional profiles
- Adding a pipeline
- nf-core components
  - Writing nf-core components
  - Adding modules to pipelines
- Tests and test data
- Gitpod
- Contributing to nf-core
- External usage
  - nf-core configs outside nf-core
- Nextflow training
  - Creating with nf-core
  - Nextflow
- Sync
- nf-core contributing overview
Usage
- Getting started
- Troubleshooting
- Reference genomes