Skip to content

Commit 4baa0b5

Browse files
authored
Improve docs on version updates; use cargo-machete 0.7.0 (#706)
* [skip ci]
1 parent 0506d94 commit 4baa0b5

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,13 @@ If you experience memory overuse or flaky tests, try limiting the number of jobs
125125

126126
To test if your contribution presents an improvement in execution time, check out the script at `scripts/benchmark/command_stat_test.py`.
127127

128+
## Updating versions
129+
130+
Generally, when updating to a new version of something (a spec file, a contract artifact, ...), a good rule of thumb is to search the repository for mentions of the old version, both in file names and content. This should also aid in not forgetting to update version mentions in the documentation.
131+
128132
### Updating OpenZeppelin contracts
129133

130-
Tests in devnet require an erc20 contract with the `Mintable` feature, keep in mind that before the compilation process of [cairo-contracts](https://github.com/OpenZeppelin/cairo-contracts/) you need to mark the `Mintable` check box in this [wizard](https://wizard.openzeppelin.com/cairo) and copy this implementation to `/src/presets/erc20.cairo`.
134+
Devnet requires an ERC20 contract with the `Mintable` feature; keep in mind that before the local compilation of [cairo-contracts](https://github.com/OpenZeppelin/cairo-contracts/) you need to mark the `Mintable` check box in this [wizard](https://wizard.openzeppelin.com/cairo) and copy the generated file to `packages/presets/src/erc20.cairo` of your local Open Zeppelin repository.
131135

132136
If smart contract constructor logic has changed, Devnet's predeployment logic needs to be changed, e.g. `simulate_constructor` in `crates/starknet-devnet-core/src/account.rs`.
133137

scripts/check_unused_deps.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
set -eu
44

55
# should skip if already installed
6-
cargo install cargo-machete
6+
cargo install cargo-machete --version 0.7.0
77

88
cargo machete

0 commit comments

Comments
 (0)