Template Repository for the SciLifeLab Data Centre

This repository provides example configurations for a set of different tools. When creating a new repository with this as a template, remember to update the information to fit your repository, and delete any files that only apply to the data-centre-template repository. Each directory / file contains information on how to adopt a template into an already existing repository.

The end goal is for this repository to be populated with examples implementing guidelines detailed in the SciLifeLab Data Centre's development guidelines repository.

Repository structure

.
├── .github/        # GitHub-specific config, e.g. workflows and templates
│   ├── pull_request_template.md
│   ├── CODEOWNERS
│   └── workflows/
│       └── ...
├── .config/        # Tool config, one subdirectory per tool
│   ├── cspell/
│   ├── lychee/
│   └── renovate/
├── docs/architecture/decisions/     # Architecture Decision Record (ADR) template
├── instructions/   # Templates for instructions, e.g. user-facing
├── .development-guidelines-version  # Version of the development-guidelines repository that this template aligns with
├── CITATION.cff            # This repo's CITATION.cff file
├── CITATION.template.cff   # Template CITATION.cff file
└── README.md

Repository contents

Configuration	Purpose	Related guidelines
.development-guidelines-version	Allows us to automatically keep track of when there's a change in the development-guidelines repository that might require a change in this repository. See ADR 0001	-
ADR template	Template to use when starting with Architecture Decision Records and adding a new decision.	Architecture Decision Records
CITATION.cff	Tells others how to cite this repository. Also enables the Cite this repository link in the repository side bar.	Citing and Citability
CITATION.template.cff	Template CITATION.cff file to copy-paste and adjust to another repository.	Citing and Citability
CODEOWNERS file	Defines which individuals or teams that are responsible for the contents of this repository.	-
CSpell	Allows spell checking for files changed in a PR	-
Citation instruction template	Template for user-facing instructions on how to cite our services and code.	Making Services and Code Citable
Lychee	Verifying that all links in the repository work	-
Pull request template	When a PR is opened, the description is automatically filled with the contents of this file. It helps make pull requests easier to prepare and review.	Pull Request Guidelines
Renovate	Allows repositories in ScilifelabDataCentre GitHub Organisation to use a custom Renovate preset in their Renovate configuration instead of teams building their own completely from scratch.	-

Links pointing to PRs will be replaced once PRs in development-guidelines repository are merged.