chore: add .git-blame-ignore-revs

refs: ATV-201
City-of-Helsinki · Jan 8, 2025 · 6a067d5 · 6a067d5
1 parent 7c60de8
commit 6a067d5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,8 @@
+# style: apply ruff
+c5542c3351ec8df7c1bafd966550b6e0f4d28304
+
+# style: add noqa N806
+ab62c2381d46946dafc0804e2730492737f6cd16
+
+# style: manual reformatting to comply with ruff
+7c60de8818107865983b453798e71a2e0df535d2
diff --git a/README.md b/README.md
@@ -121,3 +121,15 @@ commit.
 
 * Set the `DEBUG` environment variable to `1`.
 * Run `pytest`.
+
+
+## Git blame ignore refs
+
+Project includes a `.git-blame-ignore-revs` file for ignoring certain commits from `git blame`.
+This can be useful for ignoring e.g. formatting commits, so that it is more clear from `git blame`
+where the actual code change came from. Configure your git to use it for this project with the
+following command:
+
+```shell
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+```