Skip to content

Commit

Permalink
contributing: Add CONTRIBUTING.md with release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
felinira committed Feb 25, 2024
1 parent 6b11a4c commit 1daaacb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 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
- Build binaries with `cargo build --release` for `--target x86_64-pc-windows-gnu` and `--target x86_64-unknown-linux-gnu`
- 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
- Push a new crate version to crates.io with `cargo publish -p magic-wormhole`

0 comments on commit 1daaacb

Please sign in to comment.