From 993da1ee2c6154ea2c9fd907af0131defb3f587e Mon Sep 17 00:00:00 2001 From: Matti Eiden Date: Thu, 2 Jan 2025 13:29:01 +0200 Subject: [PATCH] chore: add .git-blame-ignore-revs refs: ATV-201 --- .git-blame-ignore-revs | 8 ++++++++ README.md | 13 +++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .git-blame-ignore-revs diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000..a0b6a14 --- /dev/null +++ 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 index 5efde79..6d38b22 100644 --- 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 +``` +