jarno
/
element-android
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Better formatting

This commit is contained in:
Benoit Marty 2019-10-11 17:18:54 +02:00 committed by GitHub
parent 946fc36a26
commit c57af9cf3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -42,29 +42,39 @@ Make sure the following commands execute without any error:
#### Internal tool
> ./tools/check/check_code_quality.sh
<pre>
./tools/check/check_code_quality.sh
</pre>
#### ktlint
> curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
> ./ktlint --android --experimental -v
<pre>
curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
./ktlint --android --experimental -v
</pre>
Note that you can run
> ./ktlint --android --experimental -v -F
<pre>
./ktlint --android --experimental -v -F
</pre>
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
<pre>
./gradlew lintGplayRelease
./gradlew lintFdroidRelease
</pre>
### Unit tests
Make sure the following commands execute without any error:
> ./gradlew testGplayReleaseUnitTest
<pre>
./gradlew testGplayReleaseUnitTest
</pre>
### Tests