add .git-blame-ignore-revs, doc in development_setup.md

open-AIMS · Aug 13, 2024 · 36cd956 · 36cd956
1 parent 2cc4f8c
commit 36cd956
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1 @@
+90626d5ab247c3fd642fbd3bba6c5af6ef7d5068
diff --git a/docs/src/development/development_setup.md b/docs/src/development/development_setup.md
@@ -161,6 +161,15 @@ Adding multiple values adds more guide lines at the indicated widths.
 That extension always uses its formatter settings and does not support `.JuliaFormatter.toml` whereas the main Julia extension does.
 The only reason to use the oh7z extension is for Julia projects that do not have a `.JuliaFormatter.toml` file.
 
+## Git blame ignore revs
+
+If you have GitLens (or similar extension), it will show the author of a line of code using git blame.
+To ignore commits like "re-format entire project", run this once:
+
+`git config --local blame.ignoreRevsFile .git-blame-ignore-revs`
+
+If you reformat code and want to ignore that commit, simply add the commit SHA to the `.git-blame-ignore-revs` file.
+
 ## Notes
 
 The very first import of the ADRIA package will be very slow as it attempts to precompile common functions to reduce later start up time.