From 64149665259102f6f45cb753cf0538889ef8f34f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20K=C3=BCrten?= <sebastian@mobanisto.de>
Date: Mon, 20 Dec 2021 15:12:55 +0100
Subject: [PATCH] Add unit test and style check instructions to hacking guide

---
 HACKING.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/HACKING.md b/HACKING.md
index 6ac6dc23e4..dcaec3bfc4 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -1,5 +1,29 @@
 # Hacking guide
 
+## Running style checks and unit tests
+
+When working on the code base, consider running the style checks and unit
+tests locally, because the CI will complain anyway:
+
+    ./gradlew :check
+
+The above command does both. To run style checks only:
+
+    ./gradlew ktlintCheck
+
+If that fails, try formatting:
+
+    ./gradlew ktlintFormat
+
+Running unit tests only:
+
+    ./gradlew :test --tests "*"
+
+That will run tests from the desktop project only. On the other hand, this
+will also run tests on briar core:
+
+    ./gradlew test
+
 ## Testing different locales
 
 To test the app with a different locale, add this e.g. in `Main.kt`:
-- 
GitLab