Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WSO2 invites you to contribute by downloading the source code from the GitHub source control system, building the product and making changes, and then committing your changes back to the source repository by sending a pull request for review. For information on using the Git version control system, see the Git documentation. The following sections describe this process:

Table of Contents
maxLevel3

Info

Building from source is optional. Users who do not want to make changes to the source code can simply install Developer Studio.

...

You can either clone or fork the WSO2 Developer Studio Git repository and build from source. 

To clone the repository, run the following command:

Code Block
$ git clone https://github.com/wso2/developer-studio.git

Editing the source code

Now that you have downloaded the source code from GitHub, you can prepare your development environment and do the required changes to the code. 

  1. To edit the source code in Eclipse, set up your development environment by the following command:

    IDECommandAdditional information
    Eclipsemvn eclipse:eclipsehttp://maven.apache.org/plugins/maven-eclipse-plugin

    If you are using a later Eclipse version and if you get errors (library path etc.) when trying to import the source code using the Existing Projects into Workspace option, you can solve them by importing the source code as a Maven project. To do this; open Eclipse and click Import in the File menu and then click Existing Maven Projects as shown below:

    Image Removed

  2. Add the required changes to the source code.

...

Ensure that the following prerequisites are in place before you build:

  1. Make sure the build server has an active Internet connection to download dependencies while building.
  2. Install Maven and JDK. For compatible versions, see Installation Prerequisites.
  3. Set the environment variable  MAVEN_OPTS=”-Xms1024m -Xmx4096m -XX:MaxPermSize=1024m” to avoid the Maven OutOfMemoryError.

Use the following Maven commands to build your product:

CommandDescription
mvn clean install

The binary and source distributions.

mvn clean install -Dmaven.test.skip=true The binary and source distributions, without running any of the unit tests.
mvn clean install -Dmaven.test.skip=true -o The binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you have already built the source at least once.

Committing your changes

You can contribute to WSO2 products by committing your changes to GitHub. Whether you are a committer or a non-committer, you can contribute with your code as explained in the Get Involved sectionThe source code of all WSO2 products as well as the scripts that are used for building WSO2 products are maintained in GitHub repositories. If you are a developer, you can easily clone the source code from these Git repositories, and if required, you can do modifications and build a customized product on your own.

For more information, see Using Maven to Build WSO2 Products.