Introduction

This document provides information on how to use Git to get a GitHub checkout/update, make commits to the repository, etc., in the process of contributing to Apache projects (specifically Axis2). Instructions on configuring IDEs for development and using Maven to build the project is also included here.

Working with GitHub (Git)

The Axis2 development team uses GitHub (Git) for source control.

Checkout Axis2 from Git

To check out the latest version of Axis2 from the Foundation's GitHub repository, you must use the following URL:

Once you have successfully installed Git, you can check out the Axis2 master branch by following these steps:

  1. Run git clone <repository URL> where the repository URL from the previous list.
  2. This step will check out the latest version of the Axis2 Java codebase to a directory named "axis-axis2-java-core".

Installing Maven 3

Axis2's build is based on Maven 3 and requires Maven 3.6.0 or later and JDK 17 through 25 (the build is tested on OpenJDK 17, 21 and 25). For information about obtaining, installing, and configuring Maven, please see the Maven project page. To build the Axis2 project, please install Maven and follow the instructions in the Quick Guide to Maven for Axis2.

Configuring your IDE

The Axis2 development team uses a variety of development tools from vi to emacs to Eclipse to Intellij/IDEA. The following section is not an endorsement of a specific set of tools, it is simply meant as a pointer to ease the process of getting started with Axis2 development.

Current IDEs import the Axis2 sources directly from the Maven build; no IDE-specific Maven goals are needed. Some modules generate sources during the build, so run mvn -DskipTests install once before importing so that the generated sources exist.

Intellij IDEA

Select File > Open and choose the pom.xml in the root of the checkout. IntelliJ imports every module as a Maven project.

Eclipse

With the m2e (Maven Integration for Eclipse) support included in the Eclipse IDE for Java Developers, select File > Import > Maven > Existing Maven Projects and choose the root of the checkout. All the modules are discovered and imported as individual projects at once.