From c57af9cf3e02384386f99a9dce30f2fab70e2680 Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Fri, 11 Oct 2019 17:18:54 +0200 Subject: [PATCH] Better formatting --- CONTRIBUTING.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48f8e08f06..d64dd7110e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,29 +42,39 @@ 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 -> ./ktlint --android --experimental -v +
+curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
+./ktlint --android --experimental -v
+
Note that you can run -> ./ktlint --android --experimental -v -F +
+./ktlint --android --experimental -v -F
+
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 +
+./gradlew lintGplayRelease
+./gradlew lintFdroidRelease
+
### Unit tests Make sure the following commands execute without any error: -> ./gradlew testGplayReleaseUnitTest +
+./gradlew testGplayReleaseUnitTest
+
### Tests