[DRAFT] Spotless code format

.github/workflows/test.yml

@@ -32,7 +32,8 @@ jobs:
           echo BACKTRACE_SUBMISSION_URL=\"${{ secrets.BACKTRACE_SUBMISSION_URL }}\" >> ./local.properties
           echo BACKTRACE_CORONER_URL=\"${{ secrets.BACKTRACE_CORONER_URL }}\" >> ./local.properties
           echo BACKTRACE_CORONER_TOKEN=\"${{ secrets.BACKTRACE_CORONER_TOKEN }}\" >> ./local.properties
-
+      - name: Check Code Style
+        run: ./gradlew spotlessCheck
       - name: Build and check
         run: ./gradlew assembleDebug assembleDebugAndroidTest build check
 

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: local
+    hooks:
+      - id: test-hook
+        name: test-hook
+        entry: echo 'test'
+        language: system
+        stages: [pre-commit]
+        pass_filenames: false
+
+# TODO: before merge - remove above and uncomment below
+#      - id: spotless-apply
+#        name: Spotless Apply
+#        entry: ./gradlew spotlessApply
+#        language: system
+#        stages: [pre-commit]
+#        pass_filenames: false
+#      - id: spotless-check
+#        name: Spotless Check
+#        entry: ./gradlew spotlessCheck
+#        language: system
+#        stages: [pre-commit]
+#        pass_filenames: false

CONTRIBUTING.md

@@ -3,24 +3,28 @@ Thank you for considering contributing to Backtrace Android SDK library. Here ar
 
 ### Getting Started
 
-1. **Clone the Repository**
-    - Clone the repository to your local machine using:
-      ```bash
-      git clone https://github.com/backtrace-labs/backtrace-android.git
-      ```
-
-2. **Create a Branch**
-    - It's good practice to create a new branch for each feature or bugfix, if you have jira ticket put ticket number as branch prefix:
-      ```bash
-      git checkout -b jira-ticket/your-feature-name
-      ```
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/backtrace-labs/backtrace-android.git
+   ```
+
+2. **Install pre-commit**
+   ```bash
+   pip install pre-commit
+   pre-commit install
+   ```
+
+3. **Create a branch** - it's good practice to create a new branch for each feature or bugfix, if you have jira ticket put ticket number as branch prefix:
+   ```bash
+   git checkout -b jira-ticket/your-feature-name
+   ```
 
-3. **Update submodules**
-```bash
-git submodule update --recursive --remote
-git submodule update --init --recursive
-```
-
+4. **Update submodules**
+   ```bash
+   git submodule update --recursive --remote
+   git submodule update --init --recursive
+   ```
+   
 ### Coding Guidelines
 
 1. **Code Formatting**

build.gradle

@@ -13,6 +13,25 @@ buildscript {
     }
 }
 
+plugins {
+    id 'com.diffplug.spotless' version '6.25.0' apply false
+}
+
+subprojects {
+    apply plugin: 'com.diffplug.spotless'
+    spotless {
+        java {
+            googleJavaFormat('1.25.2') // Specify the version of Google Java Format
+            indentWithTabs(1)
+            indentWithSpaces(2)
+            target fileTree('.') {
+                include '**/*.java'
+                exclude '**/build/**', '**/build-*/**', '**/.cxx/**'
+            }
+        }
+    }
+}
+
 allprojects {
     repositories {
         google()