Immich/docs/docs/developer/pr-checklist.md

PR Checklist

When contributing code through a pull request, please check the following:

Web Checks

• npm run lint (linting via ESLint)
• npm run format (formatting via Prettier)
• npm run check (Type checking via SvelteKit)
• npm test (Tests via Jest)

:::tip Run all web checks with npm run check:all :::

Server Checks

• npm run lint (linting via ESLint)
• npm run format (formatting via Prettier)
• npm run check (Type checking via tsc)
• npm test (Tests via Jest)

:::tip Run all server checks with npm run check:all :::

Open API

The Open API client libraries need to be regenerated whenever there are changes to the immich-openapi-specs.json file. See Open API for more details.

Database Migrations

A database migration needs to be generated whenever there are changes to server/libs/infra/src/entities. See Database Migration for more details.