docs: add pre-commit setup instructions

Author: lemorage

.pre-commit-config.yaml

@@ -30,18 +30,18 @@ repos:
       - id: ruff-format
         types: [python]
         pass_filenames: true
+  
+  - repo: https://github.com/christophmeissner/pytest-pre-commit
+    rev: 1.0.0
+    hooks:
+      - id: pytest
+        language: system
+        types: [python]
+        pass_filenames: false
+        always_run: false
 
   - repo: local
     hooks:
-        - id: pytest
-          name: pytest test
-          entry: pytest
-          language: system
-          types: [python]
-          pass_filenames: false
-          always_run: false
-          args: ["-v", "--strict-markers"]
-
         - id: mypy-check
           name: mypy type check
           entry: mypy

docs/docs/about/contributing.md

@@ -15,22 +15,22 @@ We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to trac
 
 We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors.
 
-## How to Contribute 
+## How to Contribute
 - If you decide to work on an issue, unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`**  or **`Can I work on this issue?`** to avoid duplicating work.
 - For larger features, we recommend you to discuss with us first in our [Discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work.
 - Our [Discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
 
-## Start hacking! Setting Up Development Environment 
+## Start hacking! Setting Up Development Environment
 Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out.
 
 -   🦀 [Install Rust](https://rust-lang.org/tools/install)
-    
+
     If you don't have Rust installed, run
     ```sh
     curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
     ```
-    Already have Rust? Make sure it's up to date 
-    ```sh 
+    Already have Rust? Make sure it's up to date
+    ```sh
     rustup update
     ```
 
@@ -46,14 +46,19 @@ Following the steps below to get cocoindex build on latest codebase locally - if
 
 -   Install required tools:
     ```sh
-    pip install maturin mypy ruff
+    pip install maturin mypy pre-commit
     ```
 
 -   Build the library. Run at the root of cocoindex directory:
     ```sh
     maturin develop
     ```
 
+-   Install and enable pre-commit hooks. This ensures all checks run automatically before each commit:
+    ```sh
+    pre-commit install
+    ```
+
 -   Before running a specific example, set extra environment variables, for exposing extra traces, allowing dev UI, etc.
     ```sh
     . ./.env.lib_debug
@@ -67,10 +72,14 @@ To submit your code:
 1. Fork the [CocoIndex repository](https://github.com/cocoindex-io/cocoindex)
 2. [Create a new branch](https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop) on your fork
 3. Make your changes
-4. Make sure all tests and linting pass by running
-   ```sh
-   ./check.sh
-   ```
+4. Run the pre-commit checks (automatically triggered on `git commit`)
+
+    :::tip
+    To run them manually (same as CI):
+        ```sh
+        pre-commit run --all-files
+        ```
+    :::
 
 5. [Open a Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) when your work is ready for review