third-party-mirrors/ultrasonic
1
0
Fork 0
mirror of https://gitlab.com/ultrasonic/ultrasonic.git synced 2025-08-11 13:01:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

ogarcia deleted page: Tips for contributing

Óscar García Amor 2022-07-21 17:14:18 +00:00
parent 8dd35b9ea2
commit 6e71686a1d
1 changed files with 0 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Tips-for-contributing.md

@ -1,40 +0,0 @@
Hi, you want to start contributing on code or with making a PR? Great!
Here are some pointers to get you started.
## Commit signing
You must enable commit signing in Git:
[See here how to set it up](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
## Pull requests and CI
On each PR Github runs a number of checks to make sure there are no problems.
### KtLint
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
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
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.