ci: Update Pull Request workflow and add pre-commit hooks

.github/workflows/pull_request.yaml

@@ -1,9 +1,10 @@
-name: Rust
+name: Pull Request
 
 on:
   pull_request:
     types:
       - opened
+      - synchronize
     paths:
       - Cargo.toml
       - '**/Cargo.toml'
@@ -35,6 +36,8 @@ jobs:
       - uses: Swatinem/rust-cache@v2
         with:
           key: rust-toolchain-cache
+      - name: Version Check
+        run: cargo fmt --version
       - name: Enforce formatting
         run: cargo fmt --check
 
@@ -49,7 +52,7 @@ jobs:
       - uses: Swatinem/rust-cache@v2
         with:
           key: rust-toolchain-cache
-      - name: Linting
+      - name: Version Check
         run: cargo clippy --version
       - name: Linting
         run: cargo clippy --all-targets -- -D warnings

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      # - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/doublify/pre-commit-rust
+    rev: v1.0
+    hooks:
+      - id: fmt
+      - id: clippy
+        args: [ --all-targets, --, -D, clippy::all ]

README.md

@@ -24,6 +24,34 @@ A flexible retry library for Rust async operations with configurable backoff str
   - `tokio` (via `tokio` feature)
   - `async-std` (via `async-std` feature)
 
+## Contributing
+
+Formatting and linting hooks are run via `pre-commit` and will run prior to each commit. If the hooks fail they will reject the commit. The `end-of-file-fixer` and `trailing-whitespace` will automatically make the necessary fixes and you can just `git add ... && git commit -m ...` again immediately. The `fmt` and `clippy` lints will require your intervention.
+
+If you _MUST_ bypass the commit hooks to get things on a branch you can `git commit --no-verify -m ...` to skip the hooks.
+
+```
+brew install pre-commit
+
+pre-commit install
+```
+
+```yaml
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      # - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/doublify/pre-commit-rust
+    rev: v1.0
+    hooks:
+      - id: fmt
+      - id: clippy
+        args: [ --all-targets, --, -D, clippy::all ]
+```
+
 ## Quick Start
 
 ```rust

examples/hello_world.rs

@@ -30,7 +30,12 @@ async fn main() {
             .stop_after(10)
             .full_jitter()
             .fixed(Duration::from_millis(200))
-            .on_retry(|res, attempt| { println!("[retry] start to call retry(): attempt = {}, prev = {:?}", attempt, res) })
+            .on_retry(|res, attempt| {
+                println!(
+                    "[retry] start to call retry(): attempt = {}, prev = {:?}",
+                    attempt, res
+                )
+            })
             .retry(|| async { this_errors("[retry] running").await })
             .await
     });
@@ -44,8 +49,14 @@ async fn main() {
             .stop_after(3)
             .full_jitter()
             .fixed(Duration::from_millis(200))
-            .on_retry(|res, attempt| { println!("[on_retry] start to call retry() again. In last attempt = {}, result = {:?}", attempt, res) })
+            .on_retry(|res, attempt| {
+                println!(
+                    "[on_retry] start to call retry() again. In last attempt = {}, result = {:?}",
+                    attempt, res
+                )
+            })
             .retry(|| async { this_errors("[retry] call `.retry()` and failed").await })
             .await
-    }).await;
+    })
+    .await;
 }