CONTRIBUTING.md

Contributing to [project name]

Overview

Please note our general guidelines for contributing to NDCLab projects here.

• Roadmap
• Directory Structure
• Scripts
• Containers
• Workflow

Roadmap

Please see the roadmap available on the README.md file of this repository.

👉 Keep the "Roadmap" text above but update the link to the readme for your repo. And, of course, delete this note before publishing the contributing file.

Directory Structure

👉 Update this section as appropriate for your repo, then delete this note before publishing.

project-name
├── code
├── containers
├── CONTRIBUTING.md
├── derivatives
├── input
├── literature
├── notebook.md
├── products
    ├──product1
          ├──code
          ├──docs
          ├──readme.md
          ├──results
├── README.md
├── results
    ├──figures
    ├──statistics

Container

To ensure reproducibility of results and software, a default docker file and singularity container are included with this template repository. The respective README.md contains a comprehensive guide on how to get started with the dockerfile. A step-by-step guide to getting started also included in the following video.

Workflow

Workflow for both internal and external lab members is outlined on the NDCLab contributing wiki page.