-
Notifications
You must be signed in to change notification settings - Fork 485
Contributors Guide
This document provides information on how to contribute to Archaius.
You can report bugs/suggestions using the following URL
https://github.com/Netflix/archaius/issues
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
After checking out the master branch, you will see the sources and junit tests under
archaius-core/src/main/java
archaius-core/src/test/java
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.
Once you have cloned the repo and checked out the master branch, 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
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 to install m2e and run this command in your eclipse project root directory
mvn eclipse:eclipse
To commit your changes, you need to issue a pull request from the repo that you have forked. Once your changes are reviewed and approved, they will be merged into the main repo.