diff options
| author | Harsh Shandilya <me@msfjarvis.dev> | 2021-10-08 10:38:09 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-08 10:38:09 +0530 |
| commit | c7fdd913c599805a92c29a7d1ddd57140e182b6e (patch) | |
| tree | 05287fb53feeae9ce6a36a17be57ddd0f43f7c93 /CONTRIBUTING.md | |
| parent | 62d78dd52a4d2949dcef805bfb0c1c1eef65d623 (diff) | |
Add `installGitHooks` task for pre-push Git hooks (#1516)
* build: add a pre-push task and Gradle task to install it
* Document `installGitHooks` in contributing.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b29e4cdd..e3e8fd0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,6 +42,10 @@ The app comes in two 'flavors', a FOSS-only **free** variant and a **nonFree** v You can find the generated APK at `app/build/outputs/apk/<variant>/debug/app-<variant>-debug.apk`. +## Pre-push checks + +The project enforces codestyle conventions and library API stability by virtue of a carefully curated Gradle build. To setup a Git pre-push hook to run them automatically, run `./gradlew installGitHooks`. + # Things to do before you start writing code If you're trying to fix a bug that already has an open issue, it's a good idea to drop a comment mentioning that you're working on a fix. If no open issue exists, ensure that you explain the bug you're fixing in some detail in the pull request body. This helps us as maintainers get a better sense of why you're making specific changes, and we might have insight into better ways of fixing the problem. |