Ultrasonic development is a community project, and contributions are welcomed.
Interested in help to translate Ultrasonic? You can contribute in our Weblate team.
By default Pull Request should be opened against develop branch, PR against master branch should be used only for critical bugfixes.
git commit --signoffto acknowledge this.
On each Pull Request GitLab runs a number of checks to make sure there are no problems.
Commits must be signed. See here how to set it up.
This programm checks if the source code is formatted correctly. You can run it yourself locally with
./gradlew -Pqc ktlintFormat
Running this command will fix common problems and will notify you of problems it couldn’t fix automatically.
Detekt is a static analyser. It helps to find potential bugs in our code. You can run it yourself locally with
./gradlew -Pqc detekt
There is a “baseline” file, in which errors which have been in the code base before are noted. Sometimes it is necessary to regenerate this file by running:
./gradlew -Pqc detektBaseline
Lint looks for general problems in the code or unused resources etc. You can run it with
./gradlew -Pqc lintRelease
If there is a need to regenerate the baseline, remove
ultrasonic/lint-baseline.xml and rerun the command.