Contribution guidelines

First off, thank you for considering contributing to r-signer.

If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.

Reporting issues

Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.

Try to do one pull request per change.

When creating pull request or squash commit message, please follow conventional commits specifications.

Update the changes you have made in CHANGELOG file under the Unreleased section.

Add the changes of your pull request to one of the following subsections, depending on the types of changes defined by Keep a changelog:

If the required subsection does not exist yet under Unreleased, create it!

This is no different than other Rust projects.

git clone https://github.com/usmansnetwork/r-signer
cd r-signer
cargo test

Build and run release version:

cargo build --release && cargo run --release

Run Clippy:

cargo clippy --all-targets --all-features --workspace

Run all tests:
```
cargo test --all-features --workspace
```
Check to see if there are code formatting issues
```
cargo fmt --all -- --check
```
Format the code in the project
```
cargo fmt --all
```