Skip to content

Latest commit

 

History

History
92 lines (57 loc) · 4.07 KB

CONTRIBUTING.adoc

File metadata and controls

92 lines (57 loc) · 4.07 KB
Raw

Contributing

This project 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 [email protected].

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. Ideally, that would include a small sample project that reproduces the problem.

Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.

Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.

  • Add the ASF license header comment to all new .java files (copy from existing files in the project)

  • Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).

  • Add some Javadocs.

  • A few unit tests would help a lot as well — someone has to do it.

  • If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).

  • When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes gh-XXXX at the end of the commit message (where XXXX is the issue number).

Working with the code

If you don’t have an IDE preference we would recommend that you use Spring Tools Suite or Eclipse when working with the code. We use the M2Eclipse eclipse plugin for maven support. Other IDEs and tools should also work without issue.

Building from source

To build the source you will need to install JDK 1.8. The project can be build with Apache Maven v3.5 or above (the Maven wrapper is included if you don’t already have Maven installed).

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

$ ./mvnw clean install
Note
 You may need to increase the amount of memory available to Maven by setting a MAVEN_OPTS environment variable with the value -Xmx512m

If you are rebuilding often, you might also want to skip the tests until you are ready to submit a pull request:

$ ./mvnw clean install -DskipTests -DskipITs

Integration tests

Docker compose is required for the integration tests that run as part of the default build. If you don’t have Docker installer, or you just want to skip the tests you can build using the -DskipITs option.

It’s also possible to build using a locally downloaded copy of Artifactory. This is helpful when you’re building the project on a system that cannot run docker compose, but it does mean you need to ensure port 8081 is free.

To run with a locally downloaded artifactory use the run-local-artifactory profile:

$ ./mvnw -Prun-local-artifactory clean install

Importing into eclipse

You can import the Spring Boot code into any Eclipse Neon based distribution.

Importing into other IDEs

Maven is well supported by most Java IDEs. Refer to your vendor documentation.