mirror of
https://github.com/immich-app/immich.git
synced 2025-03-01 15:11:21 +01:00
58e516c766
* minor * add image * PR feedback * npm run format:fix of course 4_4 * Remove what is not relevant * pr feedback * PR feedback * revert npm run format * Update docs/docs/FAQ.mdx Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> * Update FAQ.mdx --------- Co-authored-by: Alex <alex.tran1502@gmail.com> Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
# 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 AIO
|
|
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 AIO
|
|
Run all server checks with `npm run check:all`
|
|
:::
|
|
|
|
:::info Auto Fix
|
|
You can use `npm run __:fix` to potentially correct some issues automatically for `npm run format` and `lint`.
|
|
:::
|
|
|
|
## 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.
|