IES Repository Archetypes

Repository: [ies-archetypes]
Description: This repository contains administrative material to support with new IES repository creation.

This repository contains administrative material to support with new IES repository creation. When you create a new IES repository you can use this template as a base to ensure you include all the standard documentation.

This repository is public and forms part of the Information Exchange Standard initiative and is currently under the custodianship of the Department for Business, Innovation, Science and Trade (UK), acting on behalf of a cross-government group of stakeholders.

This code is licensed under the MIT License (see LICENSE.md).

Note: All documentation in this repository is licensed under the Open Government Licence v3.0 (OGL-3.0).

For full terms, see OGL_LICENSE.md.

Quick Start

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", you should also ensure original contributions are properly acknowledged.

1. Create new Repository from Template

Create a new repository from this template.

2. Update Repository Name

All references throughout the files, that refer to the repository name [ies-archetypes] should be replaced with the new target repository name.

3. Update/Remove all GUIDANCE/EXAMPLE sections

Throughout all the .md files are some GUIDANCE blocks sometimes also including EXAMPLE sections similar to that below.

<!-- 
GUIDANCE: 
 -->

These blocks don't appear on previews, they 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.

4. Pull Requests

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.

Acknowledgements

This repository has benefited from collaboration with various organisations. For a list of acknowledgments, see ACKNOWLEDGEMENTS.md.

Changelog

See CHANGELOG.md for a list of changes in each release.

Contributions and Feedback

We welcome:

• Feedback and structured suggestions
• Bug reports and clarifications
• Requests for extensions or additional documentation

Please see:

• CONTRIBUTING.md for contribution guidelines
• CODE_OF_CONDUCT.md for expected behaviour and reporting concerns
• MAINTAINERS.md for maintainer contact information

Security and Responsible Disclosure

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.

---

Maintained as part of the Information Exchange Standard initiative.

© Crown Copyright. This work forms part of the Information Exchange Standard initiative and is currently under the custodianship of the UK's Department for Business, Innovation, Science and Trade (BIST), acting on behalf of a cross-government group of stakeholders.

Licensed under the Open Government Licence v3.0.

For full licensing terms, see OGL_LICENSE.md.