raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Add documentation for git blame on ignoring formatting commits

Browse source
This commit is contained in:
Matthew de Detrich 2022-11-07 11:32:20 +01:00 • committed by Matthew de Detrich
parent f209e3b19c
commit 373e87edaa
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -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.