Thanks for considering a contribution to xpring-rs!
We're thrilled you're interested and your help is greatly appreciated. Contributing is a great way to learn about the XRP Ledger and Interledger Protocol (ILP). We are happy to review your pull requests. To make the process as smooth as possible, please read this document and follow the stated guidelines.
xpring-rs is a Rust library that is shipped as a consumable dependency in crates.io..
This library depends on Xpring Common JS, common code shared across Xpring SDK in JavaScript.
Rust comminicates via IPC with the node process to perform some of the cryptographic calculations.
Before being considered for review or merging, each pull request must:
- Follow AngularJS Git Commit Message Conventions
- Pass continuous integration tests.
- Update documentation for any new features.
- Please run
clippyandrustfmtbefore sending a pull request. - Be marked as drafts until they are ready for review.
- Adhere to the code of conduct for this repository.
Protocol buffers are compiled into Rust in the build (build.rs) process.
If JavaScript changes are required you will need to install the node dependencies and bundle them, this can be done via the build_js.sh script in the scripts folder.
$ ./build_js.shThe library should build and pass all tests.
cargo t