From 3f08ce7b03682830db8382f5da78414dd0d37214 Mon Sep 17 00:00:00 2001 From: Jim Stockwell Date: Mon, 30 Nov 2020 12:30:24 -0700 Subject: [PATCH 1/5] Document how to run unit tests --- CONTRIBUTING.adoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 3eac513e026d..403c1f065d19 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -96,7 +96,13 @@ The project can be built from the root directory using the standard Gradle comma $ ./gradlew build ---- +=== Running Unit Tests +Unit tests and checkstyle can be run from the relevant *module directory* using the standard Gradle command: +[indent=0] +---- + $ ../../gradlew check test +---- === Importing into Eclipse You can import the Spring Boot code into any Eclipse 2019-12-based distribution. The From cf5d2bc7118d4bbc1933e1b9ed97efb328c028e8 Mon Sep 17 00:00:00 2001 From: Jim Stockwell Date: Mon, 7 Dec 2020 08:38:15 -0700 Subject: [PATCH 2/5] Use only `check` task. The command now runs from the root directory, using only the check task. Also, moved the material from near the "Bulding from Source" section to being part of the "Code Conventions and Housekeeping" section. --- CONTRIBUTING.adoc | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 403c1f065d19..03b855896a9b 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -66,6 +66,8 @@ added after the original pull request but before a merge. than cosmetic changes). * Add some Javadocs. * A few unit tests would help a lot as well -- someone has to do it. +* Verification tasks, including tests and stylecheck, can be executed + by running `./gradlew check` from the project root. * If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project). * When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], @@ -96,14 +98,6 @@ The project can be built from the root directory using the standard Gradle comma $ ./gradlew build ---- -=== Running Unit Tests -Unit tests and checkstyle can be run from the relevant *module directory* using the standard Gradle command: - -[indent=0] ----- - $ ../../gradlew check test ----- - === Importing into Eclipse You can import the Spring Boot code into any Eclipse 2019-12-based distribution. The easiest way to setup a new environment is to use the Eclipse Installer with the provided From 214ac08f1e5c150256cf5c2b74878a108977c9e4 Mon Sep 17 00:00:00 2001 From: Jim Stockwell Date: Tue, 8 Dec 2020 06:22:31 -0700 Subject: [PATCH 3/5] Correct typo. stylecheck->checkstyle --- CONTRIBUTING.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 03b855896a9b..96da0ee3a64d 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -66,7 +66,7 @@ added after the original pull request but before a merge. than cosmetic changes). * Add some Javadocs. * A few unit tests would help a lot as well -- someone has to do it. -* Verification tasks, including tests and stylecheck, can be executed +* Verification tasks, including tests and checkstyle, can be executed by running `./gradlew check` from the project root. * If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project). From a35b092304fc101442e20ed4e8a27ab7977d5a39 Mon Sep 17 00:00:00 2001 From: Jim Stockwell Date: Tue, 8 Dec 2020 06:36:18 -0700 Subject: [PATCH 4/5] Capitalize checkstyle --- CONTRIBUTING.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 96da0ee3a64d..14bfec3610b7 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -54,7 +54,7 @@ added after the original pull request but before a merge. Plugin] or format the code from the Gradle build by running `./gradlew format`. Note that if you have format violations in `buildSrc`, you can fix them by running `./gradlew -p buildSrc format` from the project root directory. -* The build includes checkstyle rules for many of our code conventions. Run +* The build includes Checkstyle rules for many of our code conventions. Run `./gradlew checkstyleMain checkstyleTest` if you want to check your changes are compliant. * Make sure all new `.java` files have a Javadoc class comment with at least an @@ -66,7 +66,7 @@ added after the original pull request but before a merge. than cosmetic changes). * Add some Javadocs. * A few unit tests would help a lot as well -- someone has to do it. -* Verification tasks, including tests and checkstyle, can be executed +* Verification tasks, including tests and Checkstyle, can be executed by running `./gradlew check` from the project root. * If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project). From 5247b073e3a2b878bfc99eeab3c0d8b73151f15e Mon Sep 17 00:00:00 2001 From: Jim Stockwell Date: Tue, 8 Dec 2020 06:43:00 -0700 Subject: [PATCH 5/5] Restore vertical space before Importing sections --- CONTRIBUTING.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 14bfec3610b7..43f901c6596c 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -98,6 +98,8 @@ The project can be built from the root directory using the standard Gradle comma $ ./gradlew build ---- + + === Importing into Eclipse You can import the Spring Boot code into any Eclipse 2019-12-based distribution. The easiest way to setup a new environment is to use the Eclipse Installer with the provided