aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index ec618d0..ee0c4f2 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,30 @@ Note: this is not an official Google product.
self.ad.api.wifiEnable()
```
+## Develop
+
+If you want to contribute, use the usual github method of forking and sending
+a pull request.
+
+Before sending a pull request, run the `presubmit` target to format and run
+lint over the code. Fix any issues it indicates. When complete, send the pull
+request.
+
+```shell
+./gradlew presubmit
+```
+
+This target will reformat the code with
+[googleJavaFormat](https://github.com/sherter/google-java-format-gradle-plugin)
+and run lint. The lint report should open in your default browser.
+
+Be sure to address *all* off the errors reported by lint. When finished and you
+run `presubmit` one last time you should see:
+
+> No Issues Found
+> Congratulations!
+
+in your browser.
## Other resources