Skip to content

Commit

Permalink
Adding Spotless to DEVELOPER_GUIDE.rst
Browse files Browse the repository at this point in the history
Signed-off-by: Mitchell Gale <[email protected]>
  • Loading branch information
MitchellGale committed Jul 11, 2023
1 parent 51cf26d commit b6d9aa1
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion DEVELOPER_GUIDE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Note that missing license header will be detected by Gradle license plugin and f
Making Code Changes
===================

Project Strucure
Project Structure
----------------

The plugin codebase is in standard layout of Gradle project::
Expand Down Expand Up @@ -224,6 +224,10 @@ Most of the time you just need to run ./gradlew build which will make sure you p
- Build plugin by run all tasks above (this takes time).
* - ./gradlew pitest
- Run PiTest mutation testing (see more info in `#1204 <https://github.com/opensearch-project/sql/pull/1204>`_)
* - ./gradlew spotlessCheck
- Runs Spotless to check for code style.
* - ./gradlew spotlessApply
- Automatically apply spotless code style changes.

For integration test, you can use ``-Dtests.class`` “UT full path” to run a task individually. For example ``./gradlew :integ-test:integTest -Dtests.class="*QueryIT"``.

Expand Down

0 comments on commit b6d9aa1

Please sign in to comment.