Update contributing doc
This commit is contained in:
parent
82fc97f619
commit
946fc36a26
|
@ -40,18 +40,25 @@ Please add a line to the top of the file `CHANGES.md` describing your change.
|
||||||
|
|
||||||
Make sure the following commands execute without any error:
|
Make sure the following commands execute without any error:
|
||||||
|
|
||||||
|
#### Internal tool
|
||||||
|
|
||||||
> ./tools/check/check_code_quality.sh
|
> ./tools/check/check_code_quality.sh
|
||||||
|
|
||||||
|
#### ktlint
|
||||||
|
|
||||||
> curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
|
> curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
|
||||||
> ./ktlint --android -v
|
> ./ktlint --android --experimental -v
|
||||||
|
|
||||||
Note that you can run
|
Note that you can run
|
||||||
|
|
||||||
> ./ktlint --android -v -F
|
> ./ktlint --android --experimental -v -F
|
||||||
|
|
||||||
For ktlint to fix some detected errors for you
|
For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)
|
||||||
|
|
||||||
|
#### lint
|
||||||
|
|
||||||
> ./gradlew lintGplayRelease
|
> ./gradlew lintGplayRelease
|
||||||
|
> ./gradlew lintFdroidRelease
|
||||||
|
|
||||||
### Unit tests
|
### Unit tests
|
||||||
|
|
||||||
|
@ -61,7 +68,7 @@ Make sure the following commands execute without any error:
|
||||||
|
|
||||||
### Tests
|
### Tests
|
||||||
|
|
||||||
RiotX is currently supported on Android Jelly Bean (API 16+): please test your change on an Android device (or Android emulator) running with API 16. Many issues can happen (including crashes) on older devices.
|
RiotX is currently supported on Android KitKat (API 19+): please test your change on an Android device (or Android emulator) running with API 19. Many issues can happen (including crashes) on older devices.
|
||||||
Also, if possible, please test your change on a real device. Testing on Android emulator may not be sufficient.
|
Also, if possible, please test your change on a real device. Testing on Android emulator may not be sufficient.
|
||||||
|
|
||||||
### Internationalisation
|
### Internationalisation
|
||||||
|
|
Loading…
Reference in New Issue