[incubator-pekko-http] 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-http.git


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

commit 0e50e5d56eae749e0e7c29f18f507f4b3e432027
Author: Matthew de Detrich <ma...@aiven.io>
AuthorDate: Sat Jan 28 10:54:26 2023 +0100

    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 a75ff5979..c51d4107f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -265,6 +265,16 @@ 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
+```
+
 ## Pull request validation workflow details
 
 Pekko-http uses Github Actions to validate PRs. It builds it, runs the tests and comments on the Pull Request in GitHub.


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