This repository is a collection of metadata files that should be used to initialize new repositories if appropriate (no strong arguments speak against it).
LICENSE: using this file is mandatory for all CUBI repositoriesCITATION.md: using this file is mandatory for all CUBI repositories- if no other - more specific - citation information applies to a repository, a link to this CITATION file must be added at the end of the top-level repository README (same wording as at the end of this README).
.editorconfig: using this file is mandatory for all CUBI repositories.gitignore: strongly recommended, contains ignore rules for Python, R and some custom entries by default. There must be a good reason not to use (an extended version of) this file.
By convention, and for convenience, all CUBI metadata are organized in form of a pyproject.toml file
containing a minimal amount of descriptive entries. This file must be located at the top-level of the
respective repository. The "hierarchy" in these files is as follows:
- include Python tool settings for coherent formatting of Python code
- if the repository does not contain any Python code, this may be omitted
- include the CUBI metadata information, i.e., the top-level
pyproject.tomlin this repository - include specific metadata...
- ...for a project repository
- ...for a workflow template repository
- ...for a workflow repository
As a reminder, read the development guidelines to learn about key characteristics of workflows and projects, and naming conventions:
CUBI dev process in the knowledge base
CUBI naming conventions in the knowledge base
If not indicated otherwise above, please follow these instructions to cite this repository in your own work.