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.git
The following commit(s) were added to refs/heads/main by this push:
new 8c639b8c Add documentation for git blame on ignoring formatting commits
8c639b8c is described below
commit 8c639b8c79b5556bc50ba3dc5cacea47a81b60ff
Author: Matthew de Detrich <[email protected]>
AuthorDate: Fri Jan 6 10:57:34 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 81e9af54..57db630e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -109,6 +109,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: [email protected]
For additional commands, e-mail: [email protected]
