blob: d990684691ead196ac11f88641f100944d74416d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
# Developing
This document contains information related to development.
## Preparing Changes
First, update dependencies and tidy your changes.
```shell
cargo fmt
cargo update
cargo fix --edition-idioms --allow-dirty --allow-staged
cargo clippy --all-features --all-targets
```
Now, ensure that lints, tests, and builds succeed.
```shell
cargo fmt --all -- --check
cargo clippy -- -D warnings
cargo doc
cargo test
cargo build
```
> Alternatively, you can replace `cargo test` above with [cargo nextest](https://github.com/nextest-rs/nextest).
>
> ```shell
> cargo nextest run
> ```
## Performance Checks
Navigate to the [README in the `scripts` directory](../scripts/README.md) for more information on
how to run performance checks.
## Optional Checks
The following checks are optional and should be run occasionally.
```shell
# This command requires a nightly toolchain to be installed.
cargo +nightly udeps
cargo bloat --release
cargo bloat --release --crates
cargo audit
```
|
