From c7fdd913c599805a92c29a7d1ddd57140e182b6e Mon Sep 17 00:00:00 2001 From: Harsh Shandilya Date: Fri, 8 Oct 2021 10:38:09 +0530 Subject: 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 --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'CONTRIBUTING.md') 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//debug/app--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. -- cgit v1.2.3