We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent bfce42e commit 46c82aeCopy full SHA for 46c82ae
1 file changed
README.md
@@ -1116,10 +1116,22 @@ cargo test --lib # Unit tests only
1116
1117
- Follow Rust API guidelines
1118
- Write tests for all new code
1119
-- Use `cargo fmt` and `cargo clippy`
+- **Run `cargo fmt --all` before committing** (enforced by pre-commit hook)
1120
+- Use `cargo clippy` to check for lints
1121
- Update documentation
1122
- Use [Conventional Commits](https://www.conventionalcommits.org/)
1123
1124
+### Setup Pre-commit Hook
1125
+
1126
+Install the pre-commit hook to automatically check formatting:
1127
1128
+```bash
1129
+cp scripts/pre-commit .git/hooks/pre-commit
1130
+chmod +x .git/hooks/pre-commit
1131
+```
1132
1133
+This will prevent commits with unformatted code and ensure CI checks pass.
1134
1135
---
1136
1137
## Community
0 commit comments