Skip to content
This repository has been archived by the owner on Jul 13, 2022. It is now read-only.

Latest commit

 

History

History
61 lines (40 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 2.27 KB
Raw

Contributing

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.

About This Library

Architecture Diagram of Xpring SDK

Xpring4J is a Java library that is shipped as a consumable artifact in Maven Central..

This library relies depends on both:

Requirements for a Successful Pull Request

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 checkstyle before sending a pull request.
  • Be marked as drafts until they are ready for review.
  • Adhere to the code of conduct for this repository.

Building The Library

The protocol buffer compiler (protoc) needs to be installed in order to generate protobufs.

# Install Protocol Buffer Compiler

# OSX
$ brew install protobuf

# Linux
$ sudo apt install protobuf-compiler

# Otherwise, see: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation

The library should build and pass all tests.

# Clone repository
$ git clone https://github.com/xpring-eng/xpring4j.git
$ cd xpring4j

# Update submodules
$ git submodule update --init --recursive

# Run tests.
$ mvn clean test

Lint rules are enforced on all continuous integration builds via CheckStyle. It is recommended developers use the IntelliJ CheckStyle Plugin to lint their code during development.