Repository: [archetypes]
Description: [This repository has been put together to as a template repository, to support new repository creation]
SPDX-License-Identifier: Apache-2.0 AND OGL-UK-3.0
This repository has been put together to support with new repository creation. When you create a new repository you can use this template, as a base to ensure you include all the standard documentation, folder structure and a few base build pipelines.
While initially this repositories focus has been on creating a set of base template documentation files, the intent is to continue expanding this to include pipeline checks, that could help ensure documentation follows basic rules and checks through standard continuous integration (CI) validation examples in the future.
As this is just a template example repository the only prerequisites are to have a github account.
Important
Before using this repository, please keep in mind, these are just example files and everything has been outlined based on setting up a "new repository" and you are still expected to review any official guidance alongside using this content. If you are using these as a reference to help update an "existing repository" that may have been forked, you should also ensure original contributions are properly acknowledged, while also reflecting NDTP’s role as the maintainer and contributor of the fork as outlined by the official guidance.
Create a new repository from template using the archetypes as the template repository
All references throughout the files, that refer to the repository name archetypes should be replaced with the new target repository name
Throughout all the .md files are some GUIDANCE blocks sometimes also including EXAMPLE sections similar that below.
<!--
GUIDANCE:
-->These blocks don't appear on previews, the are just intended to help support updating the markdown file content when you first create a new repository and should be fully removed after content has been updated.
Included in this repository is an example PULL_REQUEST_TEMPLATE.md, which can be used to help prompt specific content to include in pull requests by contributors.
There are also two basic example rulesets pr_ruleset_example_default_main.json and pr_ruleset_example_develop.json that can be used to configure a minimal basic policy for you pull requests. The folder containing these files should be removed on any repositories as these are just for reference examples only.
- Base Document Templates
- Pull Request Template Example
- Dependabot Example
- Default Repository Structure Example
This repository has been developed with public funding as part of the National Digital Twin Programme (NDTP), a UK Government initiative. NDTP, alongside its partners, has invested in this work to advance open, secure, and reusable digital twin technologies for any organisation, whether from the public or private sector, irrespective of size.
This repository contains both source code and documentation, which are covered by different licenses:
- Code: Originally developed by [Original Developer, if applicable], now maintained by National Digital Twin Programme. Licensed under the Apache License 2.0.
- Documentation: Licensed under the Open Government Licence v3.0.
See LICENSE.md, OGL_LICENCE.md and NOTICE.md for details.
We take security seriously. If you believe you have found a security vulnerability in this repository, please follow our responsible disclosure process outlined in SECURITY.md.
This project provides a Software Bill of Materials (SBOM) to help users and integrators understand its dependencies.
Download the latest SBOM for this codebase to view the current list of components used in this repository.
We welcome contributions that align with the Programme’s objectives. Please read our CONTRIBUTING.md guidelines before submitting pull requests.
This repository has benefited from collaboration with various organisations. For a list of acknowledgments, see ACKNOWLEDGEMENTS.md.
For questions or support, check our Issues or contact the NDTP team on ndtp@businessandtrade.gov.uk.
Maintained by the National Digital Twin Programme (NDTP).
© Crown Copyright 2025. This work has been developed by the National Digital Twin Programme and is legally attributed to the Department for Business and Trade (UK) as the governing entity.