From 946fc36a2679eddcc5e5dada4c3d49a73b3acf64 Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Fri, 11 Oct 2019 17:12:51 +0200 Subject: [PATCH] Update contributing doc --- CONTRIBUTING.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c1fd13d74..48f8e08f06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: +#### Internal tool + > ./tools/check/check_code_quality.sh +#### 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 -> ./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 lintFdroidRelease ### Unit tests @@ -61,7 +68,7 @@ Make sure the following commands execute without any error: ### 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. ### Internationalisation