Skip to content

Latest commit

 

History

History
executable file
·
39 lines (25 loc) · 1.29 KB

CONTRIBUTING.adoc

File metadata and controls

executable file
·
39 lines (25 loc) · 1.29 KB

Contributing to Spring Fu

Spring Wave is released under the Apache 2.0 license. If you would like to contribute something, or simply want to hack on the code this document should help you get started.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.

Using GitHub Issues

We use GitHub issues to track bugs and enhancements. If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.

Building from Source

To build the source you will need to install Java 8+.

Build

The project can be built from the root directory using the standard Gradle command:

$ ./gradlew build

Documentation

Documentation can be built via the following Gradle command:

$ ./gradlew asciidoctor

In order to get syntax highlighting for Kotlin code, asciidoctor-rouge needs to be installed before running the following command:

$  asciidoctor -r asciidoctor-rouge -a source-highlighter=rouge src/docs/asciidoc/reference.adoc -o build/docs/html5/reference.html