Add pre-commit configuration (#1467)

huggingface · Feb 19, 2024 · 47c4d95 · 47c4d95
1 parent 65513e5
commit 47c4d95
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-yaml
diff --git a/docs/source/developer_guides/contributing.md b/docs/source/developer_guides/contributing.md
@@ -41,6 +41,14 @@ make quality  # just check
 make style  # check and fix
 ```
 
+You can also set up [`pre-commit`](https://pre-commit.com/) to run these fixes
+automatically as Git commit hooks.
+
+```bash
+$ pip install pre-commit
+$ pre-commit install
+```
+
 Running all the tests can take a couple of minutes, so during development it can be more efficient to only run tests specific to your change:
 
 ```sh