Debian Codegraph @

.cargo/vendor/exr/releasing.md

raw
1 # Release Checklist
2 Yanking shouldn't be the default.
3
4 ## Safety Checklist
5 1. No `unsafe`
6 1. Everything builds, not only `cargo test`
7 1. Builds with `--release` flag
8 1. All tests pass, all benchmarks run
9 1. All tests pass, including `#[ignore]` tests and fuzzing!
10 1. Images produced by running the examples can be opened in other software
11 1. Only safe `as` casts
12 1. Always have a max limit when allocating based on file contents
13 - limit max capacity `Vec::with_capacity( x.min(1024) )`
14 - careful with `vec![ 0; x ]`
15 1. Only unreachable `unwrap()`, `expect("")` and `assert`s
16 1. No `println!` outside of tests and examples
17 1. `assert_eq` and `debug_assert_eq` should have a message explaining the context, except in internal algorithms like compressors
18 1. ensure `#![warn(missing_docs)]` in `lib.rs`
19 1. Example in README.md should be up-to-date
20 1. GUIDE.md should be up-to-date
21 1. Update Dependencies while you're at it?
22
23 ## Tasks
24 1. Bump version in
25 - `cargo.toml`
26 - `README.md`
27 - `examples/README.md`
28
29 1. Run `cargo publish`
30