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:svelte` (Type checking via SvelteKit)
- [ ] `npm test` (unit tests)

:::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` (unit tests)

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

## OpenAPI

The OpenAPI client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. Note that you should not modify this file directly as it is auto-generated. See [OpenAPI](/docs/developer/open-api.md) for more details.

## Database Migrations

A database migration needs to be generated whenever there are changes to `server/src/infra/src/entities`. See [Database Migration](/docs/developer/database-migrations.md) for more details.
docs: update contributing pages (#2503) 2023-05-20 21:46:09 -04:00			`# PR Checklist`
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
			`When contributing code through a pull request, please check the following:`

docs: update contributing pages (#2503) 2023-05-20 21:46:09 -04:00			`## Web Checks`
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
			- [ ] `npm run lint` (linting via ESLint)
			- [ ] `npm run format` (formatting via Prettier)
fix(docs) Fix command name (#6368) 2024-01-13 21:16:17 +01:00			- [ ] `npm run check:svelte` (Type checking via SvelteKit)
chore: cleanup old jest references (#7198) 2024-02-19 08:54:41 -05:00			- [ ] `npm test` (unit tests)
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
			`:::tip`
			Run all web checks with `npm run check:all`
			`:::`

docs: update contributing pages (#2503) 2023-05-20 21:46:09 -04:00			`## Server Checks`
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
			- [ ] `npm run lint` (linting via ESLint)
			- [ ] `npm run format` (formatting via Prettier)
			- [ ] `npm run check` (Type checking via `tsc`)
chore: cleanup old jest references (#7198) 2024-02-19 08:54:41 -05:00			- [ ] `npm test` (unit tests)
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
			`:::tip`
			Run all server checks with `npm run check:all`
			`:::`

clarified openapi use (#3149) 2023-07-07 21:49:18 -04:00			`## OpenAPI`
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
clarified openapi use (#3149) 2023-07-07 21:49:18 -04:00			The OpenAPI client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. Note that you should not modify this file directly as it is auto-generated. See [OpenAPI](/docs/developer/open-api.md) for more details.
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
docs: update contributing pages (#2503) 2023-05-20 21:46:09 -04:00			`## Database Migrations`
chore(docs): contributing (#1311) * chore(server): linting * chore: contributing pr checklist 2023-01-12 09:44:11 -05:00
refactor(server): tsconfigs (#2689) refactor(server): tsconfigs * chore: dummy commit * fix: start.sh * chore: restore original entry scripts 2023-06-08 11:01:07 -04:00			A database migration needs to be generated whenever there are changes to `server/src/infra/src/entities`. See [Database Migration](/docs/developer/database-migrations.md) for more details.