Skip to main content

Contributing

See the contributing guide for general information on how to contribute to the ORT Server project.

Semantic versioning​

The version of a new release is determined by the types of the commit messages since the previous release, following the semantic versioning scheme. For this, the git-semver-plugin for Gradle is used. Its documentation provides a good overview of how the version is determined.

To create a new release tag, run:

./gradlew releaseVersion

Code style​

The two main languages used in this project are Kotlin and TypeScript. For both languages, there are PR checks that enforce a consistent code style. It is advised to run those checks locally before creating a PR.

For Kotlin, you can run ./gradlew detektAll to run the static code analysis. You can also force detekt to automatically fix some issues (for example, import order) by running ./gradlew detekt --auto-correct.

For TypeScript, you can run pnpm format:check within the ui/ and /website directories to check the code style. You can also automatically fix issues by running pnpm format within the respective directories.