From 1887511b182e5f59be2a57c3e83c6b1135bf897b Mon Sep 17 00:00:00 2001 From: Tak! Date: Fri, 8 Sep 2023 11:18:10 +0200 Subject: [PATCH] Update contributor documentation --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0960c91eb..fd22410e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,8 +22,9 @@ We try to follow the [Guide to app architecture](https://developer.android.com/t ### Kotlin Tusky was originally written in Java, but is in the process of migrating to Kotlin. All new code must be written in Kotlin. -We try to follow the [Kotlin Style Guide](https://developer.android.com/kotlin/style-guide) and make format the code according to the default [ktlint codestyle](https://github.com/pinterest/ktlint). -You can check the codestyle by running `./gradlew ktlintCheck`. +We try to follow the [Kotlin Style Guide](https://developer.android.com/kotlin/style-guide) and format the code according to the default [ktlint codestyle](https://github.com/pinterest/ktlint). +You can check the codestyle by running `./gradlew ktlintCheck lint`. This will fail if you have any errors, and produces a detailed report which also lists warnings. +We intentionally have very few hard linting errors, so that new contributors can focus on what they want to achieve instead of fighting the linter. ### Text All English text that will be visible to users must be put in `app/src/main/res/values/strings.xml` so it is translateable into other languages.