---
# System prepended metadata

title: configs guidelines/reviewing checklist draft
tags: [drafts, configs]

---

---
title: configs guidelines/reviewing checklist draft
tags: drafts,configs
---



- Each config/profile requires a specific person (with github handle) as a contact person
    - This can vary per sub-profile or pipeline-specific config (e.g. for different research groups etc.)

## Institutional Configs

### Config

- Main institutional configs must not have any withName or withLabel process-level specifications
    - i.e. don't specify any settings for specific modules or processes
    - @maxulysse: I think we can use the label specified in modules (`process_low`, `process_medium`, etc.)
- Environmental variables are specified as groovy variables at the top of the config with a common fallback (in the case of directories, ideally available on all UNIX OSs), and the groovy variable is inserted into strings where necessary.
    - [Example](https://github.com/nf-core/configs/blob/2b1141e9c9eca89cb1e98ac2f1cf7d6de9015540/conf/cheaha.config#L2)
- When an Institution has multiple clusters, we prefer to have each cluster as a sub-profile in the config rather than one config per cluster
    - @maxulysse: We should check if that works well with tower actually
- README updated

### Docs

- Documentation does not contain non-config related documentation 
    - e.g. _installing_ nextflow instructions should not be included
    - In contrast information about loading Nextflow so you can use the config (e.g. `module load nextflow`) _is_ allowed
    - Recommendations where to specify scratch/temporary directories are allowed (e.g. NXF environmental variables)

## Pipeline-Specific Institutional Configs

- README must be updated to indicate that the pipeline-specific profile is available at at that particular institution
- For the first pipeline-specific profile for a specific pipeline, the pipeline must have this activated 