add pre commit action w/o pre-commit applied

.github/workflows/pre-commit.yml

@@ -0,0 +1,30 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [ main, master ]
+
+jobs:
+  run-pre-commit:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Cache pre-commit
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            pre-commit-${{ runner.os }}-
+
+      - name: Run pre-commit
+        uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+default_stages:
+  - pre-commit # Run locally
+  - manual # Run in CI
+exclude: '(build|result)/.*'
+repos:
+- repo: https://github.com/google/yapf
+  rev: v0.43.0
+  hooks:
+  - id: yapf
+    args: [--in-place, --verbose]
+- repo: https://github.com/crate-ci/typos
+  rev: v1.34.0
+  hooks:
+  - id: typos
+- repo: https://github.com/PyCQA/isort
+  rev: 6.0.1
+  hooks:
+  - id: isort
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v20.1.3
+  hooks:
+  - id: clang-format
+    types_or: [c++, cuda]
+    args: [--style=file, --verbose]
+- repo: https://github.com/jackdewinter/pymarkdown
+  rev: v0.9.29
+  hooks:
+  - id: pymarkdown
+    args: [fix]
+- repo: https://github.com/rhysd/actionlint
+  rev: v1.7.7
+  hooks:
+  - id: actionlint

README.md

@@ -10,7 +10,7 @@ Optimizer is a python package that provides:
 - PyTorch implementation of recent optimizer algorithms
 - with support for parallelism techniques for efficient large-scale training.
 
-### Currently implemented
+## Currently implemented
 - [Parallel Muon with FSDP2](./docs/muon/parallel_muon.pdf)
 
 ## Usage
@@ -31,4 +31,49 @@ optim = optimizer.Muon(
     momentum=0.9,
     weight_decay=1e-4,
 )
-```
+```
+
+## Pre-commit Hooks
+
+This project uses [pre-commit](https://pre-commit.com/) to automatically check and format code before commits.
+
+### Setup
+
+1. Install pre-commit:
+
+   ```bash
+   pip install pre-commit
+   ```
+
+2. Install the git hooks:
+  
+```bash
+   pre-commit install
+   ```
+
+Once installed, the configured hooks will run automatically on each commit.
+
+### Included Hooks
+
+The following tools are run via pre-commit:
+
+- **[yapf](https://github.com/google/yapf)** – Python code formatter  
+- **[typos](https://github.com/crate-ci/typos)** – Spell checker for common typos  
+- **[isort](https://github.com/PyCQA/isort)** – Organizes and sorts Python imports  
+- **[clang-format](https://clang.llvm.org/docs/ClangFormat.html)** – Formats C++/CUDA code (`--style=file`)  
+- **[pymarkdown](https://github.com/jackdewinter/pymarkdown)** – Lints and auto-fixes Markdown files  
+- **[actionlint](https://github.com/rhysd/actionlint)** – Validates GitHub Actions workflows  
+
+### Usage
+
+- Run all checks on the entire codebase:
+
+   ```bash
+   pre-commit run --all-files
+   ```
+
+- Run a specific hook (example: isort):
+  
+ ```bash
+   pre-commit run isort --all-files
+   ```