diff --git a/docs/content/dev/2.0.md b/docs/content/dev/2.0.md index 6b92657c7..797dd67ad 100644 --- a/docs/content/dev/2.0.md +++ b/docs/content/dev/2.0.md @@ -28,3 +28,14 @@ The software provides two special groups which have no explicit users: - Run `yarn install` in both projects - Start the backend server in watch mode using `yarn start:dev`. The backend is then accessible on port 3000. - Start the frontend dev server using `yarn start`. The frontend is now accessible on port 3001. + +## Entity `create` methods + +Because we need to have empty constructors in our entity classes for TypeORM to work, the actual constructor is a separate `create` method. These methods should adhere to these guidelines: + +- Only require the non-optional properties of the corresponding entity +- Have no optional parameters +- Have no lists which can be empty (so probably most of them) +- Should either return a complete and fully useable instance or return a Pick/Omit type. +- Exceptions to these rules are allowed, if they are mentioned in the method documentation +