From 96f4a8b455f8506491cd24162b7505b5a18d2ff4 Mon Sep 17 00:00:00 2001 From: Augusto Hack Date: Tue, 5 Mar 2024 20:32:43 +0100 Subject: [PATCH 01/15] ci: turn doc warnings into errors (#259) --- .github/workflows/ci.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 89ffaea71..409295f92 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -78,7 +78,14 @@ jobs: uses: actions-rs/cargo@v1 with: command: doc - args: ${{matrix.args}} + args: + - name: Check docs + uses: actions-rs/cargo@v1 + env: + RUSTDOCFLAGS: -D warnings + with: + command: doc + args: --verbose --keep-going ${{matrix.args}} test: name: test ${{matrix.toolchain}} on ${{matrix.os}} with ${{matrix.args}} From fcb4ce57961ed344b62d32b37722921633c5cc23 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Mon, 11 Mar 2024 21:50:59 +0100 Subject: [PATCH 02/15] remove unnecessary comments --- .gitignore | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index b050493c9..d03086c8a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ # Generated by Cargo + # will have compiled files and executables debug/ target/ @@ -6,10 +7,6 @@ target/ # Generated by protox `file_descriptor_set.bin` *.bin -# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries -# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html -# Cargo.lock - # These are backup files generated by rustfmt **/*.rs.bk From c1930c5ed20956644805615e837f9364ff8b87b7 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Mon, 11 Mar 2024 22:12:13 +0100 Subject: [PATCH 03/15] Add script to check rust versions --- .github/workflows/ci.yml | 11 +++++++++++ Cargo.toml | 1 + block-producer/Cargo.toml | 2 +- node/Cargo.toml | 2 +- proto/Cargo.toml | 2 +- rpc/Cargo.toml | 2 +- scripts/check-rust-version.sh | 22 ++++++++++++++++++++++ store/Cargo.toml | 2 +- test-macro/Cargo.toml | 2 +- utils/Cargo.toml | 2 +- 10 files changed, 41 insertions(+), 7 deletions(-) create mode 100755 scripts/check-rust-version.sh diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e68234e5d..9301dc66c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -7,6 +7,17 @@ on: types: [opened, reopened, synchronize] jobs: + version: + name: check rust versions match expected version + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + profile: minimal + override: true + - name: check rust versions + run: ./scripts/check-rust-version.sh + rustfmt: name: rustfmt nightly on ubuntu-latest runs-on: ubuntu-latest diff --git a/Cargo.toml b/Cargo.toml index 3c85843bf..2567e6efc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,6 +9,7 @@ members = [ "test-macro", ] resolver = "2" +rust-version = "1.75" [workspace.dependencies] miden-crypto = { version = "0.8" } diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml index 12f547eec..561336f80 100644 --- a/block-producer/Cargo.toml +++ b/block-producer/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "program", "store"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [[bin]] name = "miden-node-block-producer" diff --git a/node/Cargo.toml b/node/Cargo.toml index 9dac4b287..b9cedd1f4 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "program"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [features] # Makes `make-genesis` subcommand run faster. Is only suitable for testing. diff --git a/proto/Cargo.toml b/proto/Cargo.toml index 6dfb39d92..297224587 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "program", "proto"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [dependencies] hex = { version = "0.4" } diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml index cd2e87602..dfe1e2e0a 100644 --- a/rpc/Cargo.toml +++ b/rpc/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "program", "rpc"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [dependencies] anyhow = { version = "1.0" } diff --git a/scripts/check-rust-version.sh b/scripts/check-rust-version.sh new file mode 100755 index 000000000..51f99ed9b --- /dev/null +++ b/scripts/check-rust-version.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +# Define the expected Rust version +EXPECTED_VERSION="1.75" + +# Check rust-toolchain file +TOOLCHAIN_VERSION=$(cat rust-toolchain) +if [ "$TOOLCHAIN_VERSION" != "$EXPECTED_VERSION" ]; then + echo "Mismatch in rust-toolchain. Expected $EXPECTED_VERSION, found $TOOLCHAIN_VERSION" + exit 1 +fi + +# Check each Cargo.toml file +for file in $(find . -name Cargo.toml); do + CARGO_VERSION=$(grep "rust-version" $file | cut -d '"' -f 2) + if [ "$CARGO_VERSION" != "$EXPECTED_VERSION" ]; then + echo "Mismatch in $file. Expected $EXPECTED_VERSION, found $CARGO_VERSION" + exit 1 + fi +done + +echo "All rust versions match ✅" diff --git a/store/Cargo.toml b/store/Cargo.toml index 730472014..eb690189e 100644 --- a/store/Cargo.toml +++ b/store/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "program", "store"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [[bin]] name = "miden-node-store" diff --git a/test-macro/Cargo.toml b/test-macro/Cargo.toml index c0d96e1d7..57092f167 100644 --- a/test-macro/Cargo.toml +++ b/test-macro/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "utils", "macro"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [dependencies] quote = { version = "1.0" } diff --git a/utils/Cargo.toml b/utils/Cargo.toml index f86bab88a..fcaf4f3d3 100644 --- a/utils/Cargo.toml +++ b/utils/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "utils"] edition = "2021" -rust-version = "1.73" +rust-version = "1.75" [dependencies] anyhow = { version = "1.0" } From 67ab767cf1eb6d2b35c827fd7d4676671db773e4 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 11:08:21 +0100 Subject: [PATCH 04/15] removed versions and editions except from root, updated script --- Cargo.toml | 1 + block-producer/Cargo.toml | 2 -- node/Cargo.toml | 2 -- proto/Cargo.toml | 2 -- rpc/Cargo.toml | 2 -- scripts/check-rust-version.sh | 21 ++++++--------------- store/Cargo.toml | 2 -- test-macro/Cargo.toml | 2 -- utils/Cargo.toml | 2 -- 9 files changed, 7 insertions(+), 29 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index fad6ada42..9f544176d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,6 +10,7 @@ members = [ ] resolver = "2" rust-version = "1.75" +edition = "2021" [workspace.dependencies] miden-air = { version = "0.8", default-features = false } diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml index 0a99e2fe8..6b7eb0e0f 100644 --- a/block-producer/Cargo.toml +++ b/block-producer/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "store"] -edition = "2021" -rust-version = "1.75" [[bin]] name = "miden-node-block-producer" diff --git a/node/Cargo.toml b/node/Cargo.toml index 26eb2ad83..e2fe77245 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node"] -edition = "2021" -rust-version = "1.75" [features] # Makes `make-genesis` subcommand run faster. Is only suitable for testing. diff --git a/proto/Cargo.toml b/proto/Cargo.toml index 4a89426e4..1266b077a 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "protobuf", "rpc"] -edition = "2021" -rust-version = "1.75" [dependencies] hex = { version = "0.4" } diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml index 336a70e5e..bfd4e501f 100644 --- a/rpc/Cargo.toml +++ b/rpc/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "rpc"] -edition = "2021" -rust-version = "1.75" [dependencies] anyhow = { version = "1.0" } diff --git a/scripts/check-rust-version.sh b/scripts/check-rust-version.sh index 51f99ed9b..420caea4f 100755 --- a/scripts/check-rust-version.sh +++ b/scripts/check-rust-version.sh @@ -1,22 +1,13 @@ #!/bin/bash -# Define the expected Rust version -EXPECTED_VERSION="1.75" - # Check rust-toolchain file TOOLCHAIN_VERSION=$(cat rust-toolchain) -if [ "$TOOLCHAIN_VERSION" != "$EXPECTED_VERSION" ]; then - echo "Mismatch in rust-toolchain. Expected $EXPECTED_VERSION, found $TOOLCHAIN_VERSION" - exit 1 -fi # Check each Cargo.toml file -for file in $(find . -name Cargo.toml); do - CARGO_VERSION=$(grep "rust-version" $file | cut -d '"' -f 2) - if [ "$CARGO_VERSION" != "$EXPECTED_VERSION" ]; then - echo "Mismatch in $file. Expected $EXPECTED_VERSION, found $CARGO_VERSION" - exit 1 - fi -done +CARGO_VERSION=$(cat Cargo.toml | grep "rust-version" | cut -d '"' -f 2) +if [ "$CARGO_VERSION" != "$TOOLCHAIN_VERSION" ]; then + echo "Mismatch in $file. Expected $TOOLCHAIN_VERSION, found $CARGO_VERSION" + exit 1 +fi -echo "All rust versions match ✅" +echo "Rust versions match ✅" diff --git a/store/Cargo.toml b/store/Cargo.toml index 3d9929eaf..c77e76205 100644 --- a/store/Cargo.toml +++ b/store/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "store"] -edition = "2021" -rust-version = "1.75" [[bin]] name = "miden-node-store" diff --git a/test-macro/Cargo.toml b/test-macro/Cargo.toml index dfd5ad2f3..fb2443a4c 100644 --- a/test-macro/Cargo.toml +++ b/test-macro/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "utils", "macro"] -edition = "2021" -rust-version = "1.75" [dependencies] quote = { version = "1.0" } diff --git a/utils/Cargo.toml b/utils/Cargo.toml index 442af69df..104040e75 100644 --- a/utils/Cargo.toml +++ b/utils/Cargo.toml @@ -7,8 +7,6 @@ readme = "README.md" license = "MIT" repository = "https://github.com/0xPolygonMiden/miden-node" keywords = ["miden", "node", "utils"] -edition = "2021" -rust-version = "1.75" [dependencies] anyhow = { version = "1.0" } From 3ad3de8b20b29c59135c03c0b6dbfa4d7907900d Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 11:11:30 +0100 Subject: [PATCH 05/15] add back cargo make doc to ci --- .github/workflows/ci.yml | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 54a826a25..9301dc66c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -61,18 +61,10 @@ jobs: with: profile: minimal override: true - - name: Doc - uses: actions-rs/cargo@v1 - with: - command: doc - args: - - name: Check docs - uses: actions-rs/cargo@v1 - env: - RUSTDOCFLAGS: -D warnings - with: - command: doc - args: --verbose --keep-going ${{matrix.args}} + - name: Install cargo make + run: cargo install cargo-make + - name: cargo make - format + run: cargo make doc test: name: test stable on ubuntu-latest From db1759d64bc404f7a7ab7bb410b3eda4944b02d6 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 11:16:54 +0100 Subject: [PATCH 06/15] Added section for testing --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd9ada360..c5731b8ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,6 +80,13 @@ For example, a new change to the `miden-node-store` crate might have the followi You can find more information about the `cargo make` commands in the [Makefile](Makefile.toml) +### Testing +After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command: + + ``` + cargo make test + ``` + ### Versioning We use [semver](https://semver.org/) naming convention. From 538ff2c90c1d2d564e11a4f0c56ed6dec627eb93 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 11:21:29 +0100 Subject: [PATCH 07/15] Fixed typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5731b8ee..653ef5bc0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,7 @@ For example, a new change to the `miden-node-store` crate might have the followi You can find more information about the `cargo make` commands in the [Makefile](Makefile.toml) ### Testing -After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command: +- After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command: ``` cargo make test From b53ea50e8e5d632c7e33ee0d614df1221c8cce11 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 11:57:22 +0100 Subject: [PATCH 08/15] Set versions to 0.1.0 + inherit all infos from workspace --- Cargo.lock | 12 ++++++------ Cargo.toml | 12 +++++++++++- block-producer/Cargo.toml | 21 ++++++++++++--------- node/Cargo.toml | 25 ++++++++++++++----------- proto/Cargo.toml | 17 ++++++++++------- rpc/Cargo.toml | 25 ++++++++++++++----------- store/Cargo.toml | 21 ++++++++++++--------- test-macro/Cargo.toml | 15 +++++++++------ utils/Cargo.toml | 15 +++++++++------ 9 files changed, 97 insertions(+), 66 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 91dd8340b..7973814ba 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1119,7 +1119,7 @@ dependencies = [ [[package]] name = "miden-node" -version = "0.2.0" +version = "0.1.0" dependencies = [ "anyhow", "clap", @@ -1138,7 +1138,7 @@ dependencies = [ [[package]] name = "miden-node-block-producer" -version = "0.2.0" +version = "0.1.0" dependencies = [ "anyhow", "async-trait", @@ -1167,7 +1167,7 @@ dependencies = [ [[package]] name = "miden-node-proto" -version = "0.2.0" +version = "0.1.0" dependencies = [ "hex", "miden-node-utils", @@ -1184,7 +1184,7 @@ dependencies = [ [[package]] name = "miden-node-rpc" -version = "0.2.0" +version = "0.1.0" dependencies = [ "anyhow", "clap", @@ -1208,7 +1208,7 @@ dependencies = [ [[package]] name = "miden-node-store" -version = "0.2.0" +version = "0.1.0" dependencies = [ "anyhow", "clap", @@ -1243,7 +1243,7 @@ dependencies = [ [[package]] name = "miden-node-utils" -version = "0.2.0" +version = "0.1.0" dependencies = [ "anyhow", "figment", diff --git a/Cargo.toml b/Cargo.toml index 9f544176d..846a3d5ed 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,9 +8,19 @@ members = [ "utils", "test-macro", ] + resolver = "2" -rust-version = "1.75" + +[workspace.package] +version = "0.1.0" edition = "2021" +rust-version = "1.75" +license = "MIT" +authors = ["Miden contributors"] +readme = "README.md" +homepage = "https://polygon.technology/polygon-miden" +repository = "https://github.com/0xPolygonMiden/miden-node" +exclude = [".github/"] [workspace.dependencies] miden-air = { version = "0.8", default-features = false } diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml index 6b7eb0e0f..bc4c6f9f5 100644 --- a/block-producer/Cargo.toml +++ b/block-producer/Cargo.toml @@ -1,12 +1,15 @@ [package] name = "miden-node-block-producer" -version = "0.2.0" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true +keywords = ["miden", "node", "block-producer"] description = "Miden node's block producer component" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" -keywords = ["miden", "node", "store"] [[bin]] name = "miden-node-block-producer" @@ -23,9 +26,9 @@ async-trait = { version = "0.1" } clap = { version = "4.3", features = ["derive"] } figment = { version = "0.10", features = ["toml", "env"] } itertools = { version = "0.12" } -miden-node-proto = { path = "../proto", version = "0.2" } -miden-node-store = { path = "../store", version = "0.2" } -miden-node-utils = { path = "../utils", version = "0.2" } +miden-node-proto = { path = "../proto" } +miden-node-store = { path = "../store" } +miden-node-utils = { path = "../utils" } miden-objects = { workspace = true } miden-processor = { workspace = true } miden-stdlib = { workspace = true } diff --git a/node/Cargo.toml b/node/Cargo.toml index e2fe77245..309531793 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -1,12 +1,15 @@ [package] name = "miden-node" -version = "0.2.0" -description = "Miden node single binary" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true keywords = ["miden", "node"] +description = "Miden node binary" [features] # Makes `make-genesis` subcommand run faster. Is only suitable for testing. @@ -17,10 +20,10 @@ tracing-forest = ["miden-node-block-producer/tracing-forest"] anyhow = { version = "1.0" } clap = { version = "4.3", features = ["derive"] } miden-lib = { workspace = true, features = ["concurrent"] } -miden-node-block-producer = { path = "../block-producer", version = "0.2" } -miden-node-rpc = { path = "../rpc", version = "0.2" } -miden-node-store = { path = "../store", version = "0.2" } -miden-node-utils = { path = "../utils", version = "0.2" } +miden-node-block-producer = { path = "../block-producer" } +miden-node-rpc = { path = "../rpc" } +miden-node-store = { path = "../store" } +miden-node-utils = { path = "../utils" } miden-objects = { workspace = true } serde = { version = "1.0", features = ["derive"] } tokio = { version = "1.29", features = ["rt-multi-thread", "net", "macros"] } @@ -29,4 +32,4 @@ tracing-subscriber = { workspace = true } [dev-dependencies] figment = { version = "0.10", features = ["toml", "env", "test"] } -miden-node-utils = { path = "../utils", version = "0.2", features = ["tracing-forest"] } +miden-node-utils = { path = "../utils", features = ["tracing-forest"] } diff --git a/proto/Cargo.toml b/proto/Cargo.toml index 1266b077a..39fd8d832 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -1,16 +1,19 @@ [package] name = "miden-node-proto" -version = "0.2.0" -description = "Miden RPC message definitions" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true keywords = ["miden", "node", "protobuf", "rpc"] +description = "Miden RPC message definitions" [dependencies] hex = { version = "0.4" } -miden-node-utils = { path = "../utils", version = "0.2" } +miden-node-utils = { path = "../utils" } miden-objects = { workspace = true } prost = { version = "0.12" } thiserror = { workspace = true } diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml index bfd4e501f..ac07b2ac8 100644 --- a/rpc/Cargo.toml +++ b/rpc/Cargo.toml @@ -1,12 +1,15 @@ [package] name = "miden-node-rpc" -version = "0.2.0" -description = "Miden node's front-end RPC server" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true keywords = ["miden", "node", "rpc"] +description = "Miden node's front-end RPC server" [dependencies] anyhow = { version = "1.0" } @@ -14,10 +17,10 @@ clap = { version = "4.3", features = ["derive"] } directories = { version = "5.0" } figment = { version = "0.10", features = ["toml", "env"] } hex = { version = "0.4" } -miden-node-block-producer = { path = "../block-producer", version = "0.2" } -miden-node-proto = { path = "../proto", version = "0.2" } -miden-node-store = { path = "../store", version = "0.2" } -miden-node-utils = { path = "../utils", version = "0.2" } +miden-node-block-producer = { path = "../block-producer" } +miden-node-proto = { path = "../proto" } +miden-node-store = { path = "../store" } +miden-node-utils = { path = "../utils" } miden-objects = { workspace = true } miden-tx = { workspace = true } prost = { version = "0.12" } @@ -30,4 +33,4 @@ tracing-subscriber = { workspace = true } [dev-dependencies] figment = { version = "0.10", features = ["toml", "env", "test"] } -miden-node-utils = { path = "../utils", version = "0.2", features = ["tracing-forest"] } +miden-node-utils = { path = "../utils", features = ["tracing-forest"] } diff --git a/store/Cargo.toml b/store/Cargo.toml index c77e76205..2dd13b3cc 100644 --- a/store/Cargo.toml +++ b/store/Cargo.toml @@ -1,12 +1,15 @@ [package] name = "miden-node-store" -version = "0.2.0" -description = "Miden node's state store component" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true keywords = ["miden", "node", "store"] +description = "Miden node's state store component" [[bin]] name = "miden-node-store" @@ -22,8 +25,8 @@ directories = { version = "5.0" } figment = { version = "0.10", features = ["toml", "env"] } hex = { version = "0.4" } miden-lib = { workspace = true } -miden-node-proto = { path = "../proto", version = "0.2" } -miden-node-utils = { path = "../utils", version = "0.2" } +miden-node-proto = { path = "../proto" } +miden-node-utils = { path = "../utils" } miden-objects = { workspace = true } once_cell = { version = "1.18.0" } prost = { version = "0.12" } @@ -39,4 +42,4 @@ tracing-subscriber = { workspace = true } [dev-dependencies] figment = { version = "0.10", features = ["toml", "env", "test"] } -miden-node-utils = { path = "../utils", version = "0.2", features = ["tracing-forest"] } +miden-node-utils = { path = "../utils", features = ["tracing-forest"] } diff --git a/test-macro/Cargo.toml b/test-macro/Cargo.toml index fb2443a4c..9cfef47ab 100644 --- a/test-macro/Cargo.toml +++ b/test-macro/Cargo.toml @@ -1,12 +1,15 @@ [package] name = "miden-node-test-macro" -version = "0.1.0" -description = "Miden's test macro" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true keywords = ["miden", "node", "utils", "macro"] +description = "Miden node's test macro" [dependencies] quote = { version = "1.0" } diff --git a/utils/Cargo.toml b/utils/Cargo.toml index 104040e75..13fb9701c 100644 --- a/utils/Cargo.toml +++ b/utils/Cargo.toml @@ -1,12 +1,15 @@ [package] name = "miden-node-utils" -version = "0.2.0" -description = "Miden node's shared utilities" -authors = ["miden contributors"] -readme = "README.md" -license = "MIT" -repository = "https://github.com/0xPolygonMiden/miden-node" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +authors.workspace = true +readme.workspace = true keywords = ["miden", "node", "utils"] +description = "Miden node's shared utilities" [dependencies] anyhow = { version = "1.0" } From 224551ba49796a29f393c3fab202a19d33de3e5f Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 16:26:00 +0100 Subject: [PATCH 09/15] Fix use of versioning --- Cargo.lock | 12 ++++++------ Cargo.toml | 2 +- block-producer/Cargo.toml | 6 +++--- node/Cargo.toml | 10 +++++----- proto/Cargo.toml | 2 +- rpc/Cargo.toml | 10 +++++----- store/Cargo.toml | 6 +++--- test-macro/Cargo.toml | 2 +- 8 files changed, 25 insertions(+), 25 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 7973814ba..91dd8340b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1119,7 +1119,7 @@ dependencies = [ [[package]] name = "miden-node" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "clap", @@ -1138,7 +1138,7 @@ dependencies = [ [[package]] name = "miden-node-block-producer" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "async-trait", @@ -1167,7 +1167,7 @@ dependencies = [ [[package]] name = "miden-node-proto" -version = "0.1.0" +version = "0.2.0" dependencies = [ "hex", "miden-node-utils", @@ -1184,7 +1184,7 @@ dependencies = [ [[package]] name = "miden-node-rpc" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "clap", @@ -1208,7 +1208,7 @@ dependencies = [ [[package]] name = "miden-node-store" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "clap", @@ -1243,7 +1243,7 @@ dependencies = [ [[package]] name = "miden-node-utils" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "figment", diff --git a/Cargo.toml b/Cargo.toml index 846a3d5ed..506d23aaa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,7 +12,7 @@ members = [ resolver = "2" [workspace.package] -version = "0.1.0" +version = "0.2.0" edition = "2021" rust-version = "1.75" license = "MIT" diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml index bc4c6f9f5..7395c4e0a 100644 --- a/block-producer/Cargo.toml +++ b/block-producer/Cargo.toml @@ -26,9 +26,9 @@ async-trait = { version = "0.1" } clap = { version = "4.3", features = ["derive"] } figment = { version = "0.10", features = ["toml", "env"] } itertools = { version = "0.12" } -miden-node-proto = { path = "../proto" } -miden-node-store = { path = "../store" } -miden-node-utils = { path = "../utils" } +miden-node-proto = { path = "../proto", version = "0.2" } +miden-node-store = { path = "../store", version = "0.2" } +miden-node-utils = { path = "../utils", version = "0.2" } miden-objects = { workspace = true } miden-processor = { workspace = true } miden-stdlib = { workspace = true } diff --git a/node/Cargo.toml b/node/Cargo.toml index 309531793..c82c5a66a 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -20,10 +20,10 @@ tracing-forest = ["miden-node-block-producer/tracing-forest"] anyhow = { version = "1.0" } clap = { version = "4.3", features = ["derive"] } miden-lib = { workspace = true, features = ["concurrent"] } -miden-node-block-producer = { path = "../block-producer" } -miden-node-rpc = { path = "../rpc" } -miden-node-store = { path = "../store" } -miden-node-utils = { path = "../utils" } +miden-node-block-producer = { path = "../block-producer", version = "0.2" } +miden-node-rpc = { path = "../rpc", version = "0.2" } +miden-node-store = { path = "../store", version = "0.2" } +miden-node-utils = { path = "../utils", version = "0.2" } miden-objects = { workspace = true } serde = { version = "1.0", features = ["derive"] } tokio = { version = "1.29", features = ["rt-multi-thread", "net", "macros"] } @@ -32,4 +32,4 @@ tracing-subscriber = { workspace = true } [dev-dependencies] figment = { version = "0.10", features = ["toml", "env", "test"] } -miden-node-utils = { path = "../utils", features = ["tracing-forest"] } +miden-node-utils = { path = "../utils", version = "0.2", features = ["tracing-forest"] } diff --git a/proto/Cargo.toml b/proto/Cargo.toml index 39fd8d832..4b72bc213 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -13,7 +13,7 @@ description = "Miden RPC message definitions" [dependencies] hex = { version = "0.4" } -miden-node-utils = { path = "../utils" } +miden-node-utils = { path = "../utils", version = "0.2" } miden-objects = { workspace = true } prost = { version = "0.12" } thiserror = { workspace = true } diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml index ac07b2ac8..938668542 100644 --- a/rpc/Cargo.toml +++ b/rpc/Cargo.toml @@ -17,10 +17,10 @@ clap = { version = "4.3", features = ["derive"] } directories = { version = "5.0" } figment = { version = "0.10", features = ["toml", "env"] } hex = { version = "0.4" } -miden-node-block-producer = { path = "../block-producer" } -miden-node-proto = { path = "../proto" } -miden-node-store = { path = "../store" } -miden-node-utils = { path = "../utils" } +miden-node-block-producer = { path = "../block-producer", version = "0.2" } +miden-node-proto = { path = "../proto", version = "0.2" } +miden-node-store = { path = "../store", version = "0.2" } +miden-node-utils = { path = "../utils", version = "0.2" } miden-objects = { workspace = true } miden-tx = { workspace = true } prost = { version = "0.12" } @@ -33,4 +33,4 @@ tracing-subscriber = { workspace = true } [dev-dependencies] figment = { version = "0.10", features = ["toml", "env", "test"] } -miden-node-utils = { path = "../utils", features = ["tracing-forest"] } +miden-node-utils = { path = "../utils", version = "0.2", features = ["tracing-forest"] } diff --git a/store/Cargo.toml b/store/Cargo.toml index 2dd13b3cc..e38d3f584 100644 --- a/store/Cargo.toml +++ b/store/Cargo.toml @@ -25,8 +25,8 @@ directories = { version = "5.0" } figment = { version = "0.10", features = ["toml", "env"] } hex = { version = "0.4" } miden-lib = { workspace = true } -miden-node-proto = { path = "../proto" } -miden-node-utils = { path = "../utils" } +miden-node-proto = { path = "../proto", version = "0.2" } +miden-node-utils = { path = "../utils", version = "0.2" } miden-objects = { workspace = true } once_cell = { version = "1.18.0" } prost = { version = "0.12" } @@ -42,4 +42,4 @@ tracing-subscriber = { workspace = true } [dev-dependencies] figment = { version = "0.10", features = ["toml", "env", "test"] } -miden-node-utils = { path = "../utils", features = ["tracing-forest"] } +miden-node-utils = { path = "../utils", version = "0.2", features = ["tracing-forest"] } diff --git a/test-macro/Cargo.toml b/test-macro/Cargo.toml index 9cfef47ab..1273db441 100644 --- a/test-macro/Cargo.toml +++ b/test-macro/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "miden-node-test-macro" -version.workspace = true +version = "0.1.0" edition.workspace = true rust-version.workspace = true license.workspace = true From bc0ab20193681a00c071dc0ba27f668791e9579a Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 12 Mar 2024 16:37:11 +0100 Subject: [PATCH 10/15] Set individual versions for crates --- block-producer/Cargo.toml | 2 +- node/Cargo.toml | 2 +- proto/Cargo.toml | 2 +- rpc/Cargo.toml | 2 +- store/Cargo.toml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml index 7395c4e0a..231f028cb 100644 --- a/block-producer/Cargo.toml +++ b/block-producer/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "miden-node-block-producer" -version.workspace = true +version = "0.2.0" edition.workspace = true rust-version.workspace = true license.workspace = true diff --git a/node/Cargo.toml b/node/Cargo.toml index c82c5a66a..ef91d4922 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "miden-node" -version.workspace = true +version = "0.2.0" edition.workspace = true rust-version.workspace = true license.workspace = true diff --git a/proto/Cargo.toml b/proto/Cargo.toml index 4b72bc213..d0cedaaf4 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "miden-node-proto" -version.workspace = true +version = "0.2.0" edition.workspace = true rust-version.workspace = true license.workspace = true diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml index 938668542..48723d662 100644 --- a/rpc/Cargo.toml +++ b/rpc/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "miden-node-rpc" -version.workspace = true +version = "0.2.0" edition.workspace = true rust-version.workspace = true license.workspace = true diff --git a/store/Cargo.toml b/store/Cargo.toml index e38d3f584..8d9919068 100644 --- a/store/Cargo.toml +++ b/store/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "miden-node-store" -version.workspace = true +version = "0.2.0" edition.workspace = true rust-version.workspace = true license.workspace = true From d3e5dc28078396212fef3269c22c0e3c68cea8b9 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Wed, 13 Mar 2024 23:18:07 +0100 Subject: [PATCH 11/15] Fixed nits, code organization and updated links --- CONTRIBUTING.md | 4 ++-- Cargo.toml | 1 - block-producer/Cargo.toml | 8 ++++---- node/Cargo.toml | 8 ++++---- proto/Cargo.toml | 8 ++++---- rpc/Cargo.toml | 8 ++++---- scripts/check-rust-version.sh | 2 +- store/Cargo.toml | 8 ++++---- test-macro/Cargo.toml | 8 ++++---- utils/Cargo.toml | 10 +++++----- 10 files changed, 32 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 653ef5bc0..f395c7df6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,10 @@ We want to make contributing to this project as easy and transparent as possible, whether it's: -- Reporting a [bug](https://github.com/0xPolygonMiden/miden-node/issues/new) +- Reporting a [bug](https://github.com/0xPolygonMiden/miden-node/issues/new?assignees=&labels=bug&projects=&template=1-bugreport.yml&title=%5BBug%5D%3A+) - Taking part in [discussions](https://github.com/0xPolygonMiden/miden-node/discussions) - Submitting a [fix](https://github.com/0xPolygonMiden/miden-node/pulls) -- Proposing new [features](https://github.com/0xPolygonMiden/miden-node/issues/new) +- Proposing new [features](https://github.com/0xPolygonMiden/miden-node/issues/new?assignees=&labels=enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)   diff --git a/Cargo.toml b/Cargo.toml index 506d23aaa..81310bd4a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,7 +12,6 @@ members = [ resolver = "2" [workspace.package] -version = "0.2.0" edition = "2021" rust-version = "1.75" license = "MIT" diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml index 231f028cb..864dd9012 100644 --- a/block-producer/Cargo.toml +++ b/block-producer/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node-block-producer" version = "0.2.0" +description = "Miden node's block producer component" +keywords = ["miden", "node", "block-producer"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node", "block-producer"] -description = "Miden node's block producer component" +homepage.workspace = true +repository.workspace = true [[bin]] name = "miden-node-block-producer" diff --git a/node/Cargo.toml b/node/Cargo.toml index ef91d4922..e9fdcc236 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node" version = "0.2.0" +description = "Miden node binary" +keywords = ["miden", "node"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node"] -description = "Miden node binary" +homepage.workspace = true +repository.workspace = true [features] # Makes `make-genesis` subcommand run faster. Is only suitable for testing. diff --git a/proto/Cargo.toml b/proto/Cargo.toml index d0cedaaf4..2080e7687 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node-proto" version = "0.2.0" +description = "Miden RPC message definitions" +keywords = ["miden", "node", "protobuf", "rpc"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node", "protobuf", "rpc"] -description = "Miden RPC message definitions" +homepage.workspace = true +repository.workspace = true [dependencies] hex = { version = "0.4" } diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml index 48723d662..48c216c76 100644 --- a/rpc/Cargo.toml +++ b/rpc/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node-rpc" version = "0.2.0" +description = "Miden node's front-end RPC server" +keywords = ["miden", "node", "rpc"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node", "rpc"] -description = "Miden node's front-end RPC server" +homepage.workspace = true +repository.workspace = true [dependencies] anyhow = { version = "1.0" } diff --git a/scripts/check-rust-version.sh b/scripts/check-rust-version.sh index 420caea4f..a98dd8bf3 100755 --- a/scripts/check-rust-version.sh +++ b/scripts/check-rust-version.sh @@ -3,7 +3,7 @@ # Check rust-toolchain file TOOLCHAIN_VERSION=$(cat rust-toolchain) -# Check each Cargo.toml file +# Check workspace Cargo.toml file CARGO_VERSION=$(cat Cargo.toml | grep "rust-version" | cut -d '"' -f 2) if [ "$CARGO_VERSION" != "$TOOLCHAIN_VERSION" ]; then echo "Mismatch in $file. Expected $TOOLCHAIN_VERSION, found $CARGO_VERSION" diff --git a/store/Cargo.toml b/store/Cargo.toml index 8d9919068..a485300df 100644 --- a/store/Cargo.toml +++ b/store/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node-store" version = "0.2.0" +description = "Miden node's state store component" +keywords = ["miden", "node", "store"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node", "store"] -description = "Miden node's state store component" +homepage.workspace = true +repository.workspace = true [[bin]] name = "miden-node-store" diff --git a/test-macro/Cargo.toml b/test-macro/Cargo.toml index 1273db441..a02c66c9c 100644 --- a/test-macro/Cargo.toml +++ b/test-macro/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node-test-macro" version = "0.1.0" +description = "Miden node's test macro" +keywords = ["miden", "node", "utils", "macro"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node", "utils", "macro"] -description = "Miden node's test macro" +homepage.workspace = true +repository.workspace = true [dependencies] quote = { version = "1.0" } diff --git a/utils/Cargo.toml b/utils/Cargo.toml index 13fb9701c..39f2d4486 100644 --- a/utils/Cargo.toml +++ b/utils/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "miden-node-utils" -version.workspace = true +version = "0.2.0" +description = "Miden node's shared utilities" +keywords = ["miden", "node", "utils"] edition.workspace = true rust-version.workspace = true license.workspace = true -homepage.workspace = true -repository.workspace = true authors.workspace = true readme.workspace = true -keywords = ["miden", "node", "utils"] -description = "Miden node's shared utilities" +homepage.workspace = true +repository.workspace = true [dependencies] anyhow = { version = "1.0" } From d748a10b14d304d7f69746192d8d7f993c51a33a Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Wed, 13 Mar 2024 23:24:07 +0100 Subject: [PATCH 12/15] Improve naming of ci job --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9301dc66c..ad8e18276 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,7 +8,7 @@ on: jobs: version: - name: check rust versions match expected version + name: check rust version consistency runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 From 810fa761c9b17335110077bf36bb4648c1fede67 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Thu, 14 Mar 2024 00:08:18 +0100 Subject: [PATCH 13/15] Fix formatting in contributing.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f395c7df6..9b66d7f3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,7 @@ For example, a new change to the `miden-node-store` crate might have the followi You can find more information about the `cargo make` commands in the [Makefile](Makefile.toml) ### Testing -- After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command: +After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command: ``` cargo make test From 74d084d9346892a5f5718fcd8cffcf488615f432 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Thu, 14 Mar 2024 00:15:48 +0100 Subject: [PATCH 14/15] Add task to format not only check --- Makefile.toml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Makefile.toml b/Makefile.toml index 4df41d232..3843976f7 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -6,6 +6,11 @@ CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true [tasks.format] toolchain = "nightly" command = "cargo" +args = ["fmt", "--all"] + +[tasks.format-check] +toolchain = "nightly" +command = "cargo" args = ["fmt", "--all", "--", "--check"] [tasks.clippy-default] @@ -34,6 +39,7 @@ args = ["test", "--all-features", "--workspace", "--", "--nocapture"] [tasks.lint] dependencies = [ "format", + "format-check", "clippy", "docs" ] From a589b96fcd8304fbd158b5e3d3528dddc7d31950 Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Thu, 14 Mar 2024 10:36:45 +0100 Subject: [PATCH 15/15] Reduced indent --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b66d7f3f..1a8ef1707 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,9 +83,9 @@ You can find more information about the `cargo make` commands in the [Makefile]( ### Testing After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command: - ``` - cargo make test - ``` +``` +cargo make test +``` ### Versioning We use [semver](https://semver.org/) naming convention.