Add git precommit hook and github actions

Author: chen

.githooks/pre-commit

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+echo "Running spotlessApply..."
+./gradlew spotlessApply
+
+# Check if spotlessApply was successful
+if [ $? -ne 0 ]; then
+    echo "❌ spotlessApply failed. Please fix the formatting issues and try again."
+    exit 1
+fi
+
+# Add the changes made by spotlessApply
+git add .
+
+echo "✅ spotlessApply completed successfully"
+exit 0 

.github/workflows/pr-checks.yml

@@ -0,0 +1,75 @@
+name: PR Checks
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+          
+      - name: Cache clang-format
+        uses: actions/cache@v3
+        id: clang-cache
+        with:
+          path: /usr/local/clang-20.1.5
+          key: clang-format-20.1.5
+          
+      - name: Install clang-format 20.1.5
+        if: steps.clang-cache.outputs.cache-hit != 'true'
+        run: |
+          echo "Installing clang-format 20.1.5..."
+          wget https://github.com/llvm/llvm-project/releases/download/llvmorg-20.1.5/clang+llvm-20.1.5-x86_64-linux-gnu-ubuntu-22.04.tar.xz
+          tar xf clang+llvm-20.1.5-x86_64-linux-gnu-ubuntu-22.04.tar.xz
+          sudo mv clang+llvm-20.1.5-x86_64-linux-gnu-ubuntu-22.04 /usr/local/clang-20.1.5
+          echo "/usr/local/clang-20.1.5/bin" >> $GITHUB_PATH
+          
+      - name: Verify clang-format installation
+        run: |
+          clang-format --version
+          if [ $? -ne 0 ]; then
+            echo "❌ clang-format installation failed"
+            exit 1
+          fi
+          
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+        
+      - name: Run spotlessCheck
+        run: |
+          echo "Running spotlessCheck..."
+          ./gradlew spotlessCheck
+          if [ $? -ne 0 ]; then
+            echo "❌ spotlessCheck failed. Please run './gradlew spotlessApply' locally to fix formatting issues."
+            exit 1
+          fi
+        
+      - name: Run detekt
+        run: |
+          echo "Running detekt..."
+          ./gradlew detekt
+          if [ $? -ne 0 ]; then
+            echo "❌ detekt found code style issues. Please fix them locally."
+            exit 1
+          fi
+        
+      - name: Run unit tests
+        run: |
+          echo "Running unit tests..."
+          ./gradlew testDebugUnitTest
+          if [ $? -ne 0 ]; then
+            echo "❌ Unit tests failed. Please fix the failing tests locally."
+            exit 1
+          fi 

README.md

@@ -230,6 +230,32 @@ With `all` option, it will conduct deep clean including open source components.
 
 WhisperKit Android is currently in the beta stage. We are actively developing the project and welcome contributions from the community.
 
+## Git Hooks
+
+This project uses Git hooks to maintain code quality. These hooks help ensure consistent code formatting and quality standards.
+
+### Setup
+
+To use the Git hooks, run the following command in your repository root:
+
+```bash
+git config core.hooksPath .githooks
+```
+
+### Available Hooks
+
+#### pre-commit
+- Runs `spotlessApply` to automatically fix code formatting issues
+- If formatting fixes are applied, they are automatically staged
+- The commit will be blocked if `spotlessApply` fails
+
+### Troubleshooting
+
+If you need to bypass the hooks temporarily (not recommended), you can use:
+```bash
+git commit --no-verify
+```
+
 # License
 
 - We release WhisperKit Android under [MIT License](LICENSE).