Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.71 KB

HowToContribute.md

File metadata and controls

49 lines (38 loc) · 1.71 KB
Raw

How to Build and Contribute

Below are guidelines for building and code contribution.

Prerequisites

  • JDK 1.8 and above
  • Maven 3.0 and above

Build from source

To build the project, run maven commands.

git clone https://github.com/Microsoft/azure-spring-boot.git 
cd azure-spring-boot
mvn clean install

Cloning the git repository on Windows

Some files in the git repository may exceed the Windows maximum file path (260 characters), depending on where you clone the repository. If you get Filename too long errors, set the core.longPaths=true git option:

git clone -c core.longPaths=true https://github.com/Microsoft/azure-spring-boot.git
cd azure-spring-boot
mvn clean install

Test

  • Run unit tests
mvn clean install
  • Skip test execution
mvn clean install -DskipTests

Version management

Developing version naming convention is like 2.0.0-SNAPSHOT. Release version naming convention is like 2.0.0. Please don't update version if no release plan.

CI

Both Travis and Appveyor CI is enabled.

Contribution

Code contribution is welcome. To contribute to existing code or add a new starter, please make sure below check list is checked.

  • Build pass. Checkstyle and findbugs is enabled by default. Please check checkstyle.xml to learn detailed checkstyle configuration.
  • Documents are updated to align with code.
  • New starter must have sample folder containing sample code and corresponding readme file.
  • Code coverage for new code >= 65%. Code coverage check is enabled with 65% bar.