aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHarsh Shandilya <me@msfjarvis.dev>2021-05-30 11:49:44 +0530
committerHarsh Shandilya <me@msfjarvis.dev>2021-05-30 11:49:44 +0530
commit0de22d7f60f9ebe9532b775ba68d12d8c164adab (patch)
tree39fc17fd2e70e11b2cadd4794af24c3a88f20c27
parent7f7c0e7cb1c63ea62d8385a3df2373a52aa0eb8f (diff)
contributing: document `unsafeLazy`
Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9a71054a..b29e4cdd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -23,6 +23,10 @@ In most scenarios, the `app` directory is where you'd be contributing changes to
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.
+## Source code conventions
+
+- Unless you're absolutely sure what you're doing, always prefer the `unsafeLazy` method over Kotlin's inbuilt `lazy` for lazily evaluated properties.
+
## Building the project
### Building with Gradle