From 097f1971cf583cccdfe19dd9d79bb1d3209146de Mon Sep 17 00:00:00 2001 From: RA <70325462+RAprogramm@users.noreply.github.com> Date: Wed, 17 Sep 2025 13:13:14 +0700 Subject: [PATCH] docs: add release checklist to readme --- README.md | 12 ++++++++++++ README.template.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/README.md b/README.md index ed1bf7d..397397f 100644 --- a/README.md +++ b/README.md @@ -246,6 +246,18 @@ MSRV = 1.89 (may raise in minor, never in patch). +
+ Release checklist + +1. `cargo +nightly fmt --` +1. `cargo clippy -- -D warnings` +1. `cargo test --all` +1. `cargo build` (regenerates README.md from the template) +1. `cargo doc --no-deps` +1. `cargo package --locked` + +
+
Non-goals diff --git a/README.template.md b/README.template.md index aa69330..bd52b5e 100644 --- a/README.template.md +++ b/README.template.md @@ -216,6 +216,18 @@ MSRV = {{MSRV}} (may raise in minor, never in patch).
+
+ Release checklist + +1. `cargo +nightly fmt --` +1. `cargo clippy -- -D warnings` +1. `cargo test --all` +1. `cargo build` (regenerates README.md from the template) +1. `cargo doc --no-deps` +1. `cargo package --locked` + +
+
Non-goals