README Standards · DOC-04

The main technologies used and any pre-requisite software that must be installed must be listed in the README: for example .NET 10, Node.js 20, Playwright.

Application Code

1. Document any required installs, such as SSL Certificates
2. Document any configuration files such as appsettings.Development.json or nuget.config
3. Document how to setup local development, including any local databases
4. Document how to run the application locally, explaining any npm scripts and any command-line options or parameters that must be provided
5. Document any additional applications (such as IDEs, or IDE extensions/plugins) which are needed for debugging etc.

Automated Tests

1. Document any required installs
2. Document any credentials required to run the tests and the file they should be added to. For example, contributors should populate cypress.env.json from the UI Cypress Tests record in Keeper.
3. Document how to run the tests locally, explaining any npm scripts and any command-line options or parameters that must be provided
4. Document any additional applications which may be used. For example, Playwright Test for VSCode by Microsoft.