Contributors Guide

This document provides information on how to contribute to Archaius.

Fork and get the source

You should first fork the Archaius project to your own account. Then you can fetch the source of Archaius from github using the following access points:

• https://github.com/your_login/archaius.git
• git@github.com:your_login/archaius.git

The source directory is under

src/archaius-core

Build

Archaius can be built with both Gradle and Maven, while Gradle is the “official” build tool. Artifacts published to Maven Central will be built with Gradle.

Build with Gradle

Once you have cloned the repo, you can use the following command to build from your working directory:

./gradlew clean build

The following directory contains built artifacts and different reports/test results.

archaius-core/build

Build with Maven

Maven build is provided mainly for better Eclipse integration. To build with Maven, use the following command from the working directory

mvn clean package

To integrate with Eclipse, you will need install m2e and run this command in your eclipse project root directory

mvn eclipse:eclipse