helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-10-17 18:19:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
immich/docs/docs/developer/pr-checklist.md
mcarbonne 5a2af558fb
feat: add minimal devcontainer setup (#14038) 
* add minimal devcontainer setup

* fix Makefile & update doc

* fix Makefile

* add warning regarding devcontainer + add newline at EOF
2024-11-13 11:28:07 -06:00

1.7 KiB
Raw Blame History

PR Checklist

A minimal devcontainer is supplied with this repository. All commands can be executed directly inside this container to avoid tedious installation of the environment. :::warning The provided devcontainer isn't complete at the moment. At least all dockerized steps in the Makefile won't work (make dev, ....). Feel free to contribute! ::: 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)

Documentation

  • npm run format (formatting via Prettier)
  • Update the _redirects file if you have renamed a page or removed it from the documentation.

:::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 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 for more details.