chore: adds RELEASE.md

claymcleod · Oct 22, 2023 · 695704d · 695704d
1 parent c738ebf
commit 695704d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,13 @@
+# Release
+
+  * [ ] Update version in `Cargo.toml`.
+  * [ ] Run tests: `cargo test --all-features`.
+  * [ ] Run linting: `cargo clippy --all-features`.
+  * [ ] Run fmt: `cargo fmt --check`.
+  * [ ] Run doc: `cargo doc`.
+  * [ ] Stage changes: `git add Cargo.lock Cargo.toml`.
+  * [ ] Create git commit: `git commit -m "release: bumps version to v0.1.0"`.
+  * [ ] Create git tag: `git tag v0.1.0`.
+  * [ ] Push release: `git push && git push --tags`.
+  * [ ] Publish the new crate: `cargo publish --all-features`.
+  * [ ] Go to the Releases page in Github and create a Release for this tag.