docs: add pre-commit guidelines for formatting and testing

This commit is contained in:
Manuel Raimann
2026-02-12 14:27:00 +01:00
parent 750bbad0d8
commit baebbae64c
3 changed files with 15 additions and 0 deletions
+5
View File
@@ -94,3 +94,8 @@ gh pr create --title "<title>" --base <target-branch> --body "$(cat <<'EOF'
EOF
)"
```
## Before you commit
1. Run `cargo +nightly fmt --all && cargo +nightly clippy --all-features --all-targets --fix --allow-dirty` to auto-format and fix lint issues.
2. Run all tests and doctests to ensure nothing is broken.
+5
View File
@@ -75,3 +75,8 @@ git commit -m "$(cat <<'EOF'
EOF
)"
```
## Before you commit
1. Run `cargo +nightly fmt --all && cargo +nightly clippy --all-features --all-targets --fix --allow-dirty` to auto-format and fix lint issues.
2. Run all tests and doctests to ensure nothing is broken.
+5
View File
@@ -74,3 +74,8 @@ git commit -m "$(cat <<'EOF'
EOF
)"
```
## Before you commit
1. Run `cargo +nightly fmt --all && cargo +nightly clippy --all-features --all-targets --fix --allow-dirty` to auto-format and fix lint issues.
2. Run all tests and doctests to ensure nothing is broken.