-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
contributing: Add CONTRIBUTING.md with release instructions
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |