chore: update codecov action version and readme

.github/workflows/test.yml

@@ -49,7 +49,7 @@ jobs:
         run: cargo tarpaulin -p ptrie --doc --tests --out xml
 
       - name: Upload to codecov.io
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           fail_ci_if_error: false
           token: ${{secrets.CODECOV_TOKEN}}

.pre-commit-config.yaml

@@ -25,11 +25,16 @@ repos:
 -   repo: local
     hooks:
     -   id: rustfmt
-        name: 🦀 Format Rust files
+        name: 🧹 Format Rust files
         description: Check if all files follow the rustfmt style
         entry: cargo fmt
         language: system
         pass_filenames: false
+    -   id: clippy
+        name: 📎 Lint with Clippy
+        entry: cargo clippy --all --all-targets --all-features
+        language: system
+        pass_filenames: false
     # -   id: git-cliff
     #     name: 🏔️ Update changelog
     #     entry: git cliff -o CHANGELOG.md

CONTRIBUTING.md

@@ -38,6 +38,13 @@ cargo tarpaulin -p ptrie --doc --tests --out html
 
 > Start web server for the cov report: `python -m http.server`
 
+### 🧹 Format and lint
+
+```bash
+cargo fmt
+cargo clippy --all --all-targets --all-features
+```
+
 ### 📚 Docs
 
 Generate docs locally:

README.md

@@ -103,6 +103,10 @@ The `serde` feature adds Serde `Serialize` and `Deserialize` traits to the `Trie
 ptrie = { version = "0.5", features = ["serde"] }
 ```
 
+## 🛠️ Contributing
+
+Contributions are welcome, checkout the [`CONTRIBUTING.md`](https://github.com/vemonet/ptrie/blob/main/CONTRIBUTING.md) for instructions to run the project in development.
+
 ## 📜 License
 
 [MIT License](https://opensource.org/licenses/MIT)