docs: add requirements to DEVELOPING.md

This commit is contained in:
Gauthier Roebroeck 2020-06-19 17:35:03 +08:00
parent 4ccfa85818
commit 331ce12806

View file

@ -2,6 +2,13 @@
Thanks a lot for contributing to Komga!
## Requirements
You will need:
- Java JDK version 8 or 11
- Nodejs version 10+, with `npm` version 6+
## Commit messages
Komga's commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) standard. This enables automatic versioning, releases, and release notes generation.
@ -21,8 +28,6 @@ Komga is composed of 2 projects:
Komga uses Spring Profiles extensively:
- `dev`: add more logging, disable periodic scanning, in-memory database
- `localdb`: a dev profile that stores the database in `./testdb`.
- `noflyway`: disable Flyway. Only useful when adding new entities and you want Hibernate to update the database for you.
- `generatesql`: used manually to write the SQL generated by Hibernate. Useful when adding new entities.
### Gradle tasks
@ -32,6 +37,7 @@ Here is a list of useful tasks:
- `bootRun`: run the application locally, useful for testing your changes.
- `copyWebDist`: build the frontend, and copy the bundle to `/resources/public`. You need to run this manually if you want to test the latest frontend build hosted by Spring.
- `test`: run automated tests. Always run this before committing.
- `jooq-codegen-primary`: generates the jOOQ DSL.
`bootRun` needs to be run with a profile or list of profiles, usually:
- `dev`: when testing with a blank database