From d24b581b686f0962c8846a32fbb52900fd0aa378 Mon Sep 17 00:00:00 2001 From: Fina Wilke Date: Sun, 25 Feb 2024 17:10:43 +0100 Subject: [PATCH] contributing: Add CONTRIBUTING.md with release instructions --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..264dae75 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +Contributions of all kind and with all levels of experience are very welcome. Before working on big changes or features please open an issue first to discuss scope and implementation details. + +## Release + +To create a new release, follow these steps: + +- Update version number in Cargo.toml for library and CLI +- Update Cargo.lock +- Commit the changes +- Tag the commit: `git tag -as a.b.c` +- Push the tag: `git push origin a.b.c` +- Create a github release for the tag and upload the built binaries from the github actions workflow +- Push a new crate version to crates.io with `cargo publish -p magic-wormhole`