aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorHarsh Shandilya <me@msfjarvis.dev>2022-04-06 18:05:59 +0530
committerGitHub <noreply@github.com>2022-04-06 12:35:59 +0000
commit0d5d5af67468f0b3db702f3789e689c234855d43 (patch)
tree46058025f23574da1da85aaad4f90f1b3ae3eb73 /CONTRIBUTING.md
parent1d6d14e6f710b74b08291e8e94c7810d3f2ccff9 (diff)
Use full canonical path for classes in manifest (#1823)
* app: switch to full class names in manifest * CONTRIBUTING: document configuration cache failures
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5884a05a..33a283f4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -51,6 +51,17 @@ The app comes in two 'flavors', a FOSS-only **free** variant and a **nonFree** v
You can find the generated APK at `app/outputs`.
+The project makes use of the unstable [Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html) feature of Gradle. This has the potential to cause spurious build failures that look something like this:
+
+```
+FAILURE: Build failed with an exception.
+
+* What went wrong:
+Could not find build ':kotlin-plugins:generatePrecompiledScriptPluginAccessors:accessors8052664764592233112'
+```
+
+This can be resolved by simply re-running the command, or adding the `--no-configuration-cache` parameter.
+
## 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`.