Merge branch 'main' into albendz_complexcondition

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,6 +7,7 @@ Thank you for your pull request! 🚀
 <!-- Please replace the empty checkboxes [] below with checked ones [x] accordingly. -->
 
 -   [] This pull request is on a [separate branch](https://docs.github.com/en/get-started/quickstart/github-flow) and not the main branch
+-   [] I have tested my code with the `./gradlew lintKotlin detekt test` command as directed in the [testing section of the contributing guide](https://github.com/scribe-org/Scribe-Data/blob/main/CONTRIBUTING.md#testing)
 
 ---
 

.github/workflows/pr_ktlint_detekt.yaml

@@ -19,6 +19,7 @@ jobs:
               with:
                   distribution: "zulu"
                   java-version: 17
+                  cache: 'gradle'
 
             - name: Setup Gradle
               uses: gradle/actions/setup-gradle@v4

.github/workflows/pr_unit_test.yaml

@@ -0,0 +1,28 @@
+name: pr_unit_test
+on:
+    pull_request:
+        branches:
+            - main
+        types: [opened, reopened, synchronize]
+
+jobs:
+    unit-test:
+        runs-on: ubuntu-latest
+        name: Run unit tests
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup JDK environment
+              uses: actions/setup-java@v4
+              with:
+                  distribution: "zulu"
+                  java-version: 17
+                  cache: 'gradle'
+
+            - name: Setup Gradle
+              uses: gradle/actions/setup-gradle@v4
+
+            - name: Run tests
+              run: ./gradlew test

CONTRIBUTING.md

@@ -15,6 +15,7 @@ If you have questions or would like to communicate with the team, please [join u
 -   [First steps as a contributor](#first-steps)
 -   [Learning the tech stack](#learning-the-tech)
 -   [Development environment](#dev-env)
+-   [Testing](#testing)
 -   [Issues and projects](#issues-projects)
 -   [Bug reports](#bug-reports)
 -   [Feature requests](#feature-requests)
@@ -119,6 +120,43 @@ git remote add upstream https://github.com/scribe-org/Scribe-Android.git
 > [!NOTE]
 > Feel free to contact the team in the [Android room on Matrix](https://matrix.to/#/#ScribeAndroid:matrix.org) if you're having problems getting your environment setup!
 
+## Pre-commit Hooks [`⇧`](#contents)
+
+Scribe-Android uses pre-commit hooks to maintain a clean and consistent codebase. These hooks help automatically check for issues such as formatting, trailing whitespace, and linting errors. Here's how to set up pre-commit for Scribe-Android:
+
+1. Install `pre-commit` by running:
+
+    ```bash
+    pip install pre-commit
+    ```
+
+2. After cloning the repository, install the hooks by running the following command in the project root:
+
+    ```bash
+    pre-commit install
+    pre-commit run --all-files  # to check
+    ```
+
+3. When you make a commit, the hooks will automatically run to check for any code quality issues. If any issues are found, they will either be fixed automatically or will need to be resolved manually.
+
+<a id="testing"></a>
+
+## Testing [`⇧`](#contents)
+
+In addition to the [pre-commit](https://pre-commit.com/) hooks that are set up during the [development environment section](#dev-env), Scribe-Android includes a testing suite that should be ran before all pull requests and subsequent commits. Please run the following in the project root:
+
+```bash
+# Run ktlint and detekt:
+./gradlew lintKotlin detekt
+./gradlew test
+```
+
+If you see that there are linting errors above, then please run the following command to hopefully fix them automatically:
+
+```bash
+ktlint --format
+```
+
 <a id="issues-projects"></a>
 
 # Issues and projects [`⇧`](#contents)

README.md

@@ -156,6 +156,15 @@ git remote add upstream https://github.com/scribe-org/Scribe-Android.git
     - Press the play button marked "Run App"
     - From here code edits that are made will be reflected in the app each time it is ran.
 
+After activating your emulator, consider setting up [pre-commit](https://pre-commit.com/) to fix common errors in the codebase before they're committed by running:
+
+```bash
+pip install --upgrade pip  # make sure that pip is at the latest version
+pip install pre-commit
+pre-commit install  # install pre-commit hooks
+# pre-commit run --all-files  # lint and fix common problems in the codebase
+```
+
 > [!NOTE]
 > Feel free to contact the team in the [Android room on Matrix](https://matrix.to/#/#ScribeAndroid:matrix.org) if you're having problems getting your environment setup!
 

app/src/main/java/be/scri/App.kt

@@ -2,7 +2,6 @@ package be.scri
 
 import android.app.Application
 import androidx.appcompat.app.AppCompatDelegate
-import be.scri.extensions.checkUseEnglish
 import be.scri.extensions.config
 
 class App : Application() {
@@ -15,6 +14,5 @@ class App : Application() {
             },
         )
         super.onCreate()
-        checkUseEnglish()
     }
 }