pre-commit hook

Author: maksimryndin

.githooks/pre-commit

@@ -0,0 +1,14 @@
+#!/bin/sh
+set -e pipefail 
+
+# Apply formatting
+cargo fmt --all || {
+    echo "❌ Cannot fmt code (run 'cargo fmt --all')"
+    exit 1
+}
+
+# Dependency sorting in Cargo.toml
+cargo sort --workspace || {
+    echo "❌ Cannot sort dependencies (run 'cargo sort --workspace')"
+    exit 1
+}

CONTRIBUTING.md

@@ -13,6 +13,7 @@ git config commit.gpgsign true
 * [Rust](https://www.rust-lang.org/tools/install)
 * [cargo deny](https://github.com/EmbarkStudios/cargo-deny)
 * [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install)
+* [cargo sort](https://github.com/DevinR528/cargo-sort)
 
 ## Code quality assurance
 

README.md

@@ -5,16 +5,18 @@ TODO(template) describe the project
 ## TODO(template) - rust template usage (remove this section after setup)
 
 This is a rust template from ZKE team :rocket: (a focus on cryptographic libs in sync Rust).
-To use it - find `TODO(template)` over the repository and set appropriate values.
+
+:bike: To use it - find `TODO(template)` over the repository and set appropriate values.
 
 - [ ] Settings -> Collaborators and teams - add your team group as admins for the repo (e.g. [zk-engineering](https://github.com/orgs/NethermindEth/teams/zk-engineering))
 - [ ] Settings -> General -> Pull Requests - allow only `Allow squash merging`, also tick `Automatically delete head branches`
 - [ ] Settings -> Pages -> Build and deployment -> Source Github Actions
 - [ ] Update the description of the repo at the repo's page, add tag topics
 - [ ] Introduce necessary sections at the repo's page (releases, deployments etc)
 - [ ] Add a website url (if applicable) or a docs page (see [docs](./.github/workflows/docs.yml) flow for public repos)
-- [ ] add [all contributors](https://allcontributors.org/docs/en/cli/installation)
-- [ ] import protection rulesets (see below) in the repo settings (Settings -> Rules -> Rulesets -> Import a ruleset)
+- [ ] Add [all contributors](https://allcontributors.org/docs/en/cli/installation)
+- [ ] Import protection rulesets (see below) in the repo settings (Settings -> Rules -> Rulesets -> Import a ruleset)
+- [ ] For binary crates with specific requirements to Rust features consider also [pinning](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file) the rust toolchain version
 
 Main branch protection
 
@@ -104,7 +106,8 @@ See [examples](./examples/).
 
 ## License
 
-TODO(template) - update [license](https://www.notion.so/nethermind/Open-Source-Software-Usage-and-Licensing-Policy-1c3360fc38d080fd9e61c29b35d1d5af) if needed
+TODO(template) - update [license](https://www.notion.so/nethermind/Open-Source-Software-Usage-and-Licensing-Policy-1c3360fc38d080fd9e61c29b35d1d5af) if needed.
+For commercial licenses it is required to get an approve from Legal.
 
 Apache 2.0
 

mycrate/Cargo.toml

@@ -12,10 +12,10 @@ license.workspace = true
 # Use `default-features = false` 
 # and explicitly list features to prevent code bloat and 
 # code break after upgrades 
-thiserror = {version = "1.0", default-features = false }
+thiserror = { version = "1.0", default-features = false }
 
 # TODO(template)
 # don't forget to put this at every crate
 # to inherit workspace's lints
 [lints]
-workspace = true
+workspace = true