Contributing to sigma-rust

Thanks for wanting to contribute! There are many ways to contribute and we appreciate any level you're willing to do.

To get started checkout issues labeled "help wanted" and "good first issue"

Process

As a heads up, we'll be running your PR through the following CI jobs:

When we're ready to release, a project owner should do the following:

Create(checkout) a release branch (naming convention release/vX-Y-Z using the ergo-lib version);
install or update "cargo release" (via cargo install cargo-release);
cargo release minor --no-dev-version -vv if you intend to bump a minor version or change minor to major to bump a major version, patch to bump a patch/hotfix version (you might want to add any crates without changes to --exclude option list, e.g. sigma-ser, sigma-util, etc.)
check the output and run it with --execute to actually execute it(make sure that you have api token from crates.io, otherwise run cargo login first);
Build and publish npm package (cd bindings/ergo-lib-wasm && npm run publish-nodejs && npm run publish-browser);
Merge release branch into develop
Merge release branch into master
Make a github release