This repository is a template repository.
When you want to create a new DA repository, you should do so by using this template. Hint: click the green button above that says "Use this template".
We want to ensure that all repositories in DA follow defined conventions and standards. See The Engineering Handbook.
Specifically, this mandates that all repositories implement at least these minimal set of pre-commit hooks and a pre-commit check. Update these as you see fit - if you need to.
It is therefore required that you use pre-commit and the detect secrets tool/hook.
They can generally be installed with pip. e.g.
pip install pre-commit
pip install detect-secrets
You will need to initialise pre-commit after cloning the newly created repository by running:
pre-commit install
README.md - Change this as appropriate.
CHANGELOG.md - A Keep a change log changelog.
LICENSE - A MIT License dated 2023 Crown Copyright.
.pre-commit-config.yaml - Sensible defaults to get you started. Add the hooks you need accordingly.
.secrets.baseline - A baseline file for detect-secrets that assumes there should be no secrets in this repository.
.github/workflows/pre_commit.yml - A workflow which runs pre-commit on a pull request to main, as a check.
Creating a repo from the template will not set branch protection. See The Engineering Handbook for guidance.