Skip to content

Commit

Permalink
Merge pull request #24301 from JimStockwell
Browse files Browse the repository at this point in the history
* pr/24301:
  Update README with instructions on running tests

Closes gh-24301
  • Loading branch information
philwebb committed Dec 9, 2020
2 parents e95c514 + f76e5d1 commit 92a7ae7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.adoc
Expand Up @@ -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
Expand All @@ -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 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).
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
Expand Down

0 comments on commit 92a7ae7

Please sign in to comment.