Ignore large scale automatic linting commits.

learningequality · Jun 12, 2024 · 5d9d6e5 · 5d9d6e5
1 parent 1a2a2c6
commit 5d9d6e5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,8 @@
+# Run this command to always ignore formatting commits in `git blame`
+# git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# Applied black to the codebase
+7dadc107cebd3ab4597f1aa4f159940872466dec
+
+# Reformatted all frontend code using prettier v3
+338b75e524ab9d5b70060c632e5f81e524d9b6e7
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -47,6 +47,12 @@ Next, initialize Git LFS:
   cd kolibri  # Enter the Kolibri directory
   git lfs install
 
+To make git blame more informative, we keep track of commits that make a lot of changes to the codebase but are not directly related to the code itself, like large scale automatic code formatting. To prevent these commits appearing in the blame output, run:
+
+.. code-block:: bash
+
+  git config blame.ignoreRevsFile .git-blame-ignore-revs
+
 Finally, add the Learning Equality repo as a remote called `upstream`. That way you can keep your local checkout updated with the most recent changes: