Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to run unit tests #24301

Closed
wants to merge 5 commits into from
Closed

Document how to run unit tests #24301

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f08ce7
Document how to run unit tests
JimStockwell Nov 30, 2020
cf5d2bc
Use only `check` task.
JimStockwell Dec 7, 2020
214ac08
Correct typo. stylecheck->checkstyle
JimStockwell Dec 8, 2020
a35b092
Capitalize checkstyle
JimStockwell Dec 8, 2020
5247b07
Restore vertical space before Importing sections
JimStockwell Dec 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.adoc
View file
Open in desktop
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