From 373e87edaae027acf4869540daa8467007f89aac Mon Sep 17 00:00:00 2001 From: Matthew de Detrich Date: Mon, 7 Nov 2022 11:32:20 +0100 Subject: [PATCH] Add documentation for git blame on ignoring formatting commits --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 302760f226..6cf9eb2788 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -417,6 +417,16 @@ Enable Travis CI #1 * Details 3 ``` +### Ignoring formatting commits in git blame + +Throughout the history of the codebase various formatting commits have been applied as the scalafmt style has evolved over time, if desired +one can setup git blame to ignore these commits. The hashes for these specific are stored in [this file](.git-blame-ignore-revs) so to configure +git blame to ignore these commits you can execute the following. + +```shell +git config blame.ignoreRevsFile .git-blame-ignore-revs +``` + ### Pull request validation workflow details Akka uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.