README

All repositories should contain a readme.md at the root. The goal with this file is that it should have enough information to allow another competent developer to get the project up and running in their local development environment. Where necessary, the readme file can reference external resources (like Miro) for more detailed information, though access to Miro shouldn’t be necessary to get the local development environment running.

Sample contents

# Customer overview

- What they do, plus reason for project

## Environments

Suggested content
- List the URLs for each environment
- Add details of specific usernames to fulfill specific roles (passwords should be in 1Password)

## Framework versions

- What version of the framework is being used.

## Getting started

Suggested content:
- Dependencies on projects in other repos
- Licences required (if any)
- Authentication setup (if applicable), including any IP exclusions that have to be configured
- Database setup (especially any seeding requirements)
- Configuration setup - list all the configuration keys with definitions

## Committing Code

- Rules for commits (for example, always prefix with Ticket number)
- Development approach (for example, TDD, clean architecture, CQS/CQRS)
- PR checks (for example, manual review, successful build, all tests pass, static code analysis)