From 5d9d6e560b79332f3d15830284a7757697112baf Mon Sep 17 00:00:00 2001 From: Richard Tibbles Date: Wed, 15 May 2024 16:51:12 -0700 Subject: [PATCH] Ignore large scale automatic linting commits. --- .git-blame-ignore-revs | 8 ++++++++ docs/getting_started.rst | 6 ++++++ 2 files changed, 14 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 00000000000..bacd893d3a8 --- /dev/null +++ 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 index 58ccf67a53f..351777bd9e2 100644 --- 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: