meta: add an ignore-revs file and document its use

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
This commit is contained in:
Harsh Shandilya 2021-05-15 15:33:20 +05:30
parent 7e2eb2425e
commit cdf8e76ac6
No known key found for this signature in database
GPG key ID: 366D7BBAD1031E80
2 changed files with 5 additions and 0 deletions

3
.git-blame-ignore-revs Normal file
View file

@ -0,0 +1,3 @@
5e66d99c852ea67a88b650c03b0e8d55e83eccde # Package name restructure
774fda83ac276a635e3402034b1eedbd10be916f # Tree-wide reformat
7e2eb2425e7b9b6ccb37b7b89f19de3fa7a20c44 # Another tree-wide reformat to address a Spotless misconfiguration

View file

@ -21,6 +21,8 @@ The source code is split across 4 modules.
In most scenarios, the `app` directory is where you'd be contributing changes to. While most of the code has been rewritten and documented, there are still gnarly "legacy" parts that might be challenging to understand at a glance. Please get in touch via the [Discussions](https://github.com/android-password-store/Android-Password-Store/discussions) page with any questions you have, and we'd love to explain and improve things. In most scenarios, the `app` directory is where you'd be contributing changes to. While most of the code has been rewritten and documented, there are still gnarly "legacy" parts that might be challenging to understand at a glance. Please get in touch via the [Discussions](https://github.com/android-password-store/Android-Password-Store/discussions) page with any questions you have, and we'd love to explain and improve things.
We bundle a [`ignore-revs-file`](https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt) to ensure `git blame` is not affected by noisy changes. To make use of this, run `git config blame.ignoreRevsFile .git-blame-ignore-revs` from inside this repository.
## Building the project ## Building the project
### Building with Gradle ### Building with Gradle