homestar
</img>
##
Outline
- Usage
- Testing the Project
- Benchmarking the Project
- Contributing
- Getting Help
- External Resources
- License
Usage
Add the following to the [dependencies] section of your Cargo.toml file:
ipvm = "0.1.0"
Testing the Project
-
Run tests
cargo test --all-features
Benchmarking the Project
For benchmarking and measuring performance, this project leverages
criterion and a test_utils feature flag
for integrating proptest within the the suite for working with
strategies and sampling from randomly generated values.
-
Run benchmarks
cargo bench --features test_utils
Contributing
:balloon: We’re thankful for any feedback and help in improving our project! We have a contributing guide to help you get involved. We also adhere to our Code of Conduct.
Nix
This repository contains a Nix flake that initiates both the Rust toolchain set in rust-toolchain.toml and a pre-commit hook. It also installs helpful cargo binaries for development. Please install nix and direnv to get started.
Run nix develop or direnv allow to load the devShell flake output,
according to your preference.
Formatting
For formatting Rust in particular, please use cargo +nightly fmt as it uses
specific nightly features we recommend by default.
Pre-commit Hook
This project recommends using pre-commit for running pre-commit hooks. Please run this before every commit and/or push.
- If you are doing interim commits locally, and for some reason if you don’t
want pre-commit hooks to fire, you can run
git commit -a -m "Your message here" --no-verify.
Recommended Development Flow
- We recommend leveraging cargo-watch, cargo-expand and irust for Rust development.
- We recommend using cargo-udeps for removing unused dependencies before commits and pull-requests.
Conventional Commits
This project lightly follows the Conventional Commits
convention to help explain
commit history and tie in with our release process. The full specification
can be found here. We recommend prefixing your commits with
a type of fix, feat, docs, ci, refactor, etc…, structured like so:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
Getting Help
For usage questions, usecases, or issues reach out to us in our Discord channel.
We would be happy to try to answer your question or try opening a new issue on Github.
External Resources
These are references to specifications, talks and presentations, etc.
License
This project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.