diff options
| author | Kristen Kozak <sebright@google.com> | 2017-03-29 13:29:13 -0700 |
|---|---|---|
| committer | Kristen Kozak <sebright@google.com> | 2017-03-29 16:41:39 -0700 |
| commit | 9cdff724b15f07fe4677ce4e306f6c068dbf9082 (patch) | |
| tree | b0527409fba2f409442b82bec5fcd9c5eac5cc8a /CONTRIBUTING.md | |
| parent | a5ff0dce5ff630cbeeec775d9b78cb0c453d7234 (diff) | |
| download | opencensus-java-9cdff724b15f07fe4677ce4e306f6c068dbf9082.tar.gz | |
Mention Windows build command and git history check in CONTRIBUTING.md.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b64b39e..290a75e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,9 +54,15 @@ We also follow these project-specific guidelines: constructors to all AutoValue classes to prevent classes in other packages from extending them. +## Building instrumentation-java + +Run `./gradlew clean assemble check` on OS X or Linux, or run +`gradlew.bat clean assemble check` on Windows. This command performs the same +checks as the continuous integration build. + ## Proposing changes -Make sure that `./gradlew clean assemble check` completes successfully without -any new warnings. Then create a Pull Request with your changes. When the changes -are accepted, they will be merged or cherry-picked by an Instrumentation core -developer. +Create a Pull Request with your changes. The continuous integration build will +run the tests and static analysis. It will also check that the pull request +branch has no merge commits. When the changes are accepted, they will be merged +or cherry-picked by an Instrumentation core developer. |