Modify git-hook docs, with an eye towards a future where there is both a pre-push hook or a pre-commit hook, depending on what the user prefers.

Author: ntwigg

plugin-gradle/README.md

@@ -53,7 +53,7 @@ Spotless supports all of Gradle's built-in performance features (incremental bui
 
 - [**Quickstart**](#quickstart)
   - [Requirements](#requirements)
-  - [Git pre-push hook](#git-pre-push-hook)
+  - [Git hook (optional)](#git-hook)
   - [Linting](#linting)
 - **Languages**
   - [Java](#java) ([google-java-format](#google-java-format), [eclipse jdt](#eclipse-jdt), [clang-format](#clang-format), [prettier](#prettier), [palantir-java-format](#palantir-java-format), [formatAnnotations](#formatAnnotations), [cleanthat](#cleanthat), [IntelliJ IDEA](#intellij-idea))
@@ -142,34 +142,19 @@ Spotless requires JRE 11+ and Gradle 6.1.1 or newer.
 - If you're stuck on JRE 8, use [`id 'com.diffplug.spotless' version '6.13.0'` or older](https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md#6130---2023-01-14).
 - If you're stuck on an older version of Gradle, [`id 'com.diffplug.gradle.spotless' version '4.5.1'` supports all the way back to Gradle 2.x](https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md#451---2020-07-04).
 
-### Git pre-push hook
+### Git hook
 
-You can install a Git pre-push hook that ensures code is properly formatted before being pushed to a remote repository.
-This helps catch formatting issues early — before CI fails — and is especially useful for teams not using IDE integrations or pre-commit tools.
+If you want, you can run `./gradlew spotlessInstallGitPrePushHook` and it will install a hook such that
 
-#### What the hook does
-
-When installed, the Git `pre-push` hook will:
-
-1. Run `spotlessCheck`
+1. When you push, it runs `spotlessCheck`
 2. If formatting issues are found:
    - It automatically runs `spotlessApply` to fix them
    - Aborts the push with a message
    - You can then commit the changes and push again
 
 This ensures your code is always clean before it leaves your machine.
 
-#### Installation
-
-Run the following task once in your project:
-```console
-gradle spotlessInstallGitPrePushHook
-```
-
-This installs a `.git/hooks/pre-push` script that runs `spotlessCheck`, and runs `spotlessApply` if needed.
-
-> [!WARNING]
-> The hook will not install automatically — you must run the install command manually.
+If you prefer instead to have a "pre-commit" hook so that every single commit is clean, see [#623](https://github.com/diffplug/spotless/issues/623) for a workaround or to contribute a permanent fix.
 
 ### Linting
 

plugin-maven/README.md

@@ -37,7 +37,7 @@ user@machine repo % mvn spotless:check
 
 - [**Quickstart**](#quickstart)
   - [Requirements](#requirements)
-  - [Git pre-push hook](#git-pre-push-hook)
+  - [Git hook (optional)](#git-hook)
   - [Binding to maven phase](#binding-to-maven-phase)
 - **Languages**
   - [Java](#java) ([google-java-format](#google-java-format), [eclipse jdt](#eclipse-jdt), [prettier](#prettier), [palantir-java-format](#palantir-java-format), [formatAnnotations](#formatAnnotations), [cleanthat](#cleanthat), [IntelliJ IDEA](#intellij-idea))
@@ -147,34 +147,19 @@ Spotless consists of a list of formats (in the example above, `misc` and `java`)
 Spotless requires Maven to be running on JRE 11+. To use JRE 8, go back to [`2.30.0` or older](https://github.com/diffplug/spotless/blob/main/plugin-maven/CHANGES.md#2300---2023-01-13).
 
 
-### Git pre-push hook
+### Git hook
 
-You can install a Git pre-push hook that ensures code is properly formatted before being pushed to a remote repository.
-This helps catch formatting issues early — before CI fails — and is especially useful for teams not using IDE integrations or pre-commit tools.
+If you want, you can run `mvn spotless:install-git-pre-push-hook` and it will install a hook such that
 
-#### What the hook does
-
-When installed, the Git `pre-push` hook will:
-
-1. Run `spotless:check`
+1. When you push, it runs `spotless:check`
 2. If formatting issues are found:
-  - It automatically runs `spotless:apply` to fix them
-  - Aborts the push with a message
-  - You can then commit the changes and push again
+   - It automatically runs `spotless:apply` to fix them
+   - Aborts the push with a message
+   - You can then commit the changes and push again
 
 This ensures your code is always clean before it leaves your machine.
 
-#### Installation
-
-Run the following task once in your project:
-```console
-mvn spotless:install-git-pre-push-hook
-```
-
-This installs a `.git/hooks/pre-push` script that runs `spotless:check`, and runs `spotless:apply` if needed.
-
-> [!WARNING]
-> The hook will not install automatically — you must run the install command manually.
+If you prefer instead to have a "pre-commit" hook so that every single commit is clean, see [#623](https://github.com/diffplug/spotless/issues/623) for a workaround or to contribute a permanent fix.
 
 ### Binding to maven phase