[incubator-pekko-connectors-kafka] branch main updated: Add documentation for git blame on ignoring formatting commits

[md...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mdedetrich pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-connectors-kafka.git


The following commit(s) were added to refs/heads/main by this push:
     new 9a6cc63f Add documentation for git blame on ignoring formatting commits
9a6cc63f is described below

commit 9a6cc63f2cd6b154f15bdb6537d4ad6fb193bdb4
Author: Matthew de Detrich <ma...@aiven.io>
AuthorDate: Sun Jan 15 13:23:18 2023 +0100

    Add documentation for git blame on ignoring formatting commits
---
 CONTRIBUTING.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 021479e4..5ed70d40 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -96,6 +96,15 @@ Example:
     * Details 2
     * 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
+```
 
 ## How To Enforce These Guidelines?
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org