Merge pull request #881 from IntersectMBO/smelc/git-blame-ignore-refo…

…rmatting Add .git-blame-ignore-revs file
IntersectMBO · Sep 5, 2024 · a8e11ff · a8e11ff
2 parents c9fbcda + fcdadf7
commit a8e11ff
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1 @@
+9d1fd093071278be77428dba189d958d5b7a7aeb
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -66,3 +66,11 @@ See the [RELEASING.md](RELEASING.md) for instructions.
 Please note that libraries need bounds on the version of their dependencies to avoid bitrot and be effectively reusable.
 
 [CHaP]: https://github.com/input-output-hk/cardano-haskell-packages
+
+## Improving `git blame`
+
+You can have `git blame` ignore the reformatting done when [introducting fourmolu](https://github.com/IntersectMBO/cardano-cli/pull/835/commits/9d1fd093071278be77428dba189d958d5b7a7aeb) by specifying `blame.ignoreRevsFile` to `.git-blame-ignore-revs` in your repository's git configuration. Do it as follows:
+
+```shell
+git config --local blame.ignoreRevsFile .git-blame-ignore-revs
+```