Skip to content

Commit f76e5d1

Browse files
JimStockwellphilwebb
authored andcommitted
Update README with instructions on running tests
See gh-24301
1 parent e95c514 commit f76e5d1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ added after the original pull request but before a merge.
5454
Plugin] or format the code from the Gradle build by running
5555
`./gradlew format`. Note that if you have format violations in `buildSrc`, you can fix
5656
them by running `./gradlew -p buildSrc format` from the project root directory.
57-
* The build includes checkstyle rules for many of our code conventions. Run
57+
* The build includes Checkstyle rules for many of our code conventions. Run
5858
`./gradlew checkstyleMain checkstyleTest` if you want to check your changes are
5959
compliant.
6060
* Make sure all new `.java` files have a Javadoc class comment with at least an
@@ -66,6 +66,8 @@ added after the original pull request but before a merge.
6666
than cosmetic changes).
6767
* Add some Javadocs.
6868
* A few unit tests would help a lot as well -- someone has to do it.
69+
* Verification tasks, including tests and Checkstyle, can be executed
70+
by running `./gradlew check` from the project root.
6971
* If no-one else is using your branch, please rebase it against the current master (or
7072
other target branch in the main project).
7173
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],

0 commit comments

Comments
 (0)