chore: add .git-blame-ignore-revs

refs: ATV-201
City-of-Helsinki · Jan 2, 2025 · 170d7d4 · 170d7d4
1 parent 13e6795
commit 170d7d4
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,8 @@
+# style: apply ruff
+8b39c0726a6844cc35bb43b71ac039a28ba46ba1
+
+# style: add noqa N806
+a8311aca44ed32890b41db908c7c76111e6bb372
+
+# style: manual reformatting to comply with ruff
+13e6795b4b932b2cab89428b14491eaac521f26e
diff --git a/README.md b/README.md
@@ -121,3 +121,16 @@ 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
+```
+