From c1c3f070a51f5c0cdf1d50a447b114bed9e3d6e2 Mon Sep 17 00:00:00 2001 From: jason plumb <75337021+breedx-splk@users.noreply.github.com> Date: Mon, 28 Oct 2024 08:47:35 -0700 Subject: [PATCH] Make the spotless usage block level (#656) * make the spotless usage block level * spotless (oh the irony!) --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2de038270..22525acf8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,8 +44,13 @@ The output artifacts will be in `instrumentation/build/outputs/`. We use [spotless](https://github.com/diffplug/spotless) to enforce a consistent code style throughout the project. This includes reformatting (linting) of both source code and markdown. -Before submitting a PR, you should ensure that your code is linted by -running `./gradlew spotlessApply` and committing your changes. +Before submitting a PR, you should ensure that your code is linted. We use the +[spotless gradle plugin](https://github.com/diffplug/spotless/tree/main/plugin-gradle) to +make this easy. You should run it like this: + +``` +./gradlew spotlessApply +``` ### Tests