First off, thank you for considering contributing to simple-hyper-client.
If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.
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.
Please create your commits following the Conventional Commits rules. This will enable you to use some tools to update changelog easily.
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:
Addedfor new features.Changedfor changes in existing functionality.Deprecatedfor soon-to-be removed features.Removedfor now removed features.Fixedfor any bug fixes.Securityin case of vulnerabilities.
If the required subsection does not exist yet under Unreleased, create it!
If new commits are added following Conventional Commits
rules, you could use
cargo changelog command provided from
cargo-smart-release to update
changelogs:
cargo changelog simple-hyper-client simple-hyper-client-native-tls simple-hyper-client-rustls --writeThis is no different than other Rust projects.
git clone https://github.com/fortanix/simple-hyper-client
cd simple-hyper-client
cargo test-
Build release version:
cargo build --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