This is an internal documentation. There is a good chance you’re looking for something else. See Disclaimer.

Backend Repository Guidelines

nice2validate

Several configuration errors are caught by validators that are run by our CD tool. See .ci/validators/bin/ in the repository for the validators.

These validators can also be executed as a pre-push hook. A gradle task setupPrePush should run automatically when importing the project which copies the hook to the correct location. If it didn’t, you can just run it yourself.

This requires some dependencies to be installed on your system. If they are not installed, a message gets logged and no pre-push hook will be setup. At point of writing, the dependencies are:

  • python3

  • pip

  • yamllint

  • parallel

Install these through apt install, brew install or whatever other packager manager or method you use.

If you want to push without these validators being run, you can use the --no-verify argument when pushing from the command line, or disable the Run git hooks in IntelliJ Idea.

Commit Message

  • On the first line is the subject. There is a limit of 72 characters. The message is written in the present (E.g. change and not changed or changes)

  • If more details are helpful add a message body. Between the subject and message body must be an empty line.

  • Use the Refs or Closes command to link your commit to a Jira task.

add new monitoring module

- add logic to track requests
- add visualization of requests over time
- add custom JSON exporter

Refs: TOCDEV-1234

XML

  • Use hyphen syntax for element and attribute names, i.e., all lowercase letters; do not use camel case for elements (E. g. set-status-date).

  • If a publicform is customer specific changed it cannot be partially replaced. It requires:

<form xmlns="http://nice2.tocco.ch/schema/formModel.xsd" data="My_entity" replace="true">

  • Non trivial entities, relations and fields are documented with the <documentation> element.