Skip to main content

Coding Guidelines

These pages are the conventions of the project. Follow them in every change, and review pull requests against them.

PageCovers
JavaPackage structure, naming, Spring beans, DTOs, errors, Javadoc
Server and API DesignRoute prefixes, where server code belongs, DTO rules
TypeScript and AngularComponents, signals, templates, types, API services
Styling and ThemingSCSS structure, colors, responsive layout
TestingServer and client tests, checks before a pull request
Writing DocumentationHow to write and build pages of this site

A convention changes in a pull request like any code change. When you change one, update its page in the same pull request, so that this site stays the single place where the conventions are written down.

Search documentation