Add .git-blame-ignore-revs, and docs on how to use it

Kinto · Jan 24, 2024 · 09076ff · 09076ff
1 parent 099cf36
commit 09076ff
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# Run prettier after installing @trivago/prettier-plugin-sort-imports
+f993f8379304ce0f44cae0bd4b76b004aa1caa30
diff --git a/README.md b/README.md
@@ -83,6 +83,12 @@ Install packages:
 $ cd kinto-admin && npm install
 ```
 
+Optionally, configure `git` to use `.git-blame-ignore-revs` to remove noisy commits (e.g. running `prettier` on the entire codebase) from `git blame`:
+
+```
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+```
+
 After installation of packages, run the development server.
 
 ## Development server
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Run prettier after installing @trivago/prettier-plugin-sort-imports
		f993f8379304ce0f44cae0bd4b76b004aa1caa30