Please note our general guidelines for contributing to NDCLab projects here.
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.
👉 Update this section as appropriate for your repo, then delete this note before publishing.
project-name
├── run.py
├── scripts
| ├──__init__.py
├── container
| ├──Dockerfile.template
| ├──environment.yml
| ├──README.md
├── .github The scripts directory is the local package where Python modules will be written. This ensures that modules are neatly divided according to responsibility, which helps with parallel development and debugging.
To ensure reproducibility of results and software, a default docker file is included with this template repository. The respective README.md contains a comprehensive guide on how to get started with containerization (special thanks to Jonhas)!
A step-by-step guide to getting started also included in the following video.
Workflow for both internal and external lab members is outlined on the NDCLab contributing wiki page.