Thanks for considering a contribution to Xpring SDK!
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.
XpringKit is a Swift library that is shipped as a consumable artifact in both the CocoaPods and Carthage dependency management systems.
This library relies depends on both:
- Xpring Common JS: Common code shared across Xpring SDK in JavaScript.
- Xpring Common Protocol Buffers: Common protocol buffers shared across Xpring SDK.
Before being considered for review or merging, each pull request must:
- Pass continuous integration tests.
- Update documentation for any new features.
- Be free of lint errors. Please run
swiftlintbefore sending a pull request. - Be marked as drafts until they are ready for review.
- Adhere to the code of conduct for this repository.
The library should build and pass all tests.
# Clone repository
$ git clone https://github.com/xpring-eng/xpringkit.git
$ cd xpringkit
# Pull submodules
$ git submodule update --init --recursive
# Install required tooling
$ brew tap yonaskolb/SwagGen https://github.com/yonaskolb/SwagGen.git
$ brew install xcodegen swiftlint carthage swift-protobuf grpc-swift SwagGen
# Recommended: Install linter configuration to run SwiftLint from within XCode:
# See: https://github.com/ypresto/SwiftLintXcode
# Generate project
$ ./scripts/generate_project.sh
$ open XpringKit.xcodeproj