> For the complete documentation index, see [llms.txt](https://connector.interledger4j.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://connector.interledger4j.dev/contributing/development.md).

# Connector Development

## Getting Started as a Contributor

### Project Build Requirements

This project the following software in order to build:

* **Java**: This project requires Java JDK8 or above. To install, follow the directions [here](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
* **Maven**: This project uses Maven to manage dependencies and other aspects of the build. To install Maven, follow the instructions at <https://maven.apache.org/install.html>.

### Checkout & Build

To get started, download the code and then build the project:

```bash
$ git clone https://github.com/sappenin/java-ilpv4-connector
$ mvn clean install
```

### Checkstyle

The project uses checkstyle to keep code-style consistent. All Checkstyle checks are run by default during the build, but if you would like to run checkstyle checks independently, use the following command:

```bash
$ mvn checkstyle:checkstyle
```

### File an Issue

If you find a bug, have an idea, or even a question -- feel free to [create an issue in Github](https://github.com/sappenin/java-ilpv4-connector/issues) and we'll take a look as soon as possible.