From 7ae54c1a8e1a5e2f94dff490286c3fd1d81a25c9 Mon Sep 17 00:00:00 2001 From: Alex Saveau Date: Tue, 10 Jan 2017 13:11:19 -0800 Subject: [PATCH 1/2] Add info regarding tests, lint, and checkstyle Signed-off-by: Alex Saveau --- CONTRIBUTING.md | 4 +++- PULL_REQUEST_TEMPLATE.md | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f5f2c969..157de7009 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,8 +30,10 @@ Feature parity (where it makes sense) is a strict requirement for feature develo ### Code reviews All submissions, including submissions by project members, require review. We -use Github pull requests for this purpose. We adhere to the +use GitHub pull requests for this purpose. We adhere to the [Google Java style guide](https://google.github.io/styleguide/javaguide.html). +In addition, style and lint checks are run on each build to ensure quality. To run the full +suite of tests, checks, lint, etc, run `./gradlew check` (this will ensure the Travis build passes). ### The small print diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index ef2ac817a..21b841784 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,6 @@ Hey there! So you want to contribute to FirebaseUI? Before you file this pull request, follow these steps: * Read [the contribution guidelines](CONTRIBUTING.md). + * Run `./gradlew check` to ensure the Travis build passes. * If this has been discussed in an issue, make sure to mention the issue number here. If not, go file an issue about this to make sure this is a desirable change. * If this is a new feature please co-ordinate with someone on [FirebaseUI-iOS](https://github.com/firebase/firebaseui-ios) to make sure that we can implement this on both platforms and maintain feature parity. From 5e899d5abf33ee3271ba59262cd306d7d339a5e7 Mon Sep 17 00:00:00 2001 From: Alex Saveau Date: Tue, 10 Jan 2017 14:11:42 -0800 Subject: [PATCH 2/2] Cleanup Signed-off-by: Alex Saveau --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 157de7009..8178aef42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,8 +32,8 @@ Feature parity (where it makes sense) is a strict requirement for feature develo All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. We adhere to the [Google Java style guide](https://google.github.io/styleguide/javaguide.html). -In addition, style and lint checks are run on each build to ensure quality. To run the full -suite of tests, checks, lint, etc, run `./gradlew check` (this will ensure the Travis build passes). +In addition, style and lint checks are run on each Travis build to ensure quality. To run the full +suite of tests, checks, lint, etc, use `./gradlew check` (this will ensure the Travis build passes). ### The small print