Dev Get the Source Code

Get the Windup Source Code

If you just plan to create Java-based rule add-ons, you do not need to get the Windup source code. You only need to configure Maven to build your Java-base rule add-on project.

However, if you plan to contribute to the Windup code base, you need to fork and clone the 3 following Windup GitHub repositories.

• Windup core code base: https://github.com/windup/windup

• Windup XML-based rulesets: https://github.com/windup/windup-rulesets

• Windup distribution: https://github.com/windup/windup-distribution

The basic workflow process is to fork the above Windup repositories to your own Git, clone your forks, commit your work in topic branches, and make pull requests back to the corresponding repository.

Install the Git Client

If you don’t have the Git client (git), get it from: http://git-scm.com/

• Be sure to generate an SSH key and add the public key to your GitHub account: https://help.github.com/articles/generating-ssh-keys. You can verify the key using the following command:

ssh -T git@github.com

+ You should see a message indicating your ID has successfully authenticated.

• You should also configure your name and email identity using the following commands:

git config --global user_name "FIRST_NAME LAST_NAME"
git config --global user_email "YOUR_EMAIL_ADDRESS"

Fork and Clone the Windup Repository

1. Fork the Windup project. This creates the windup project in your own Git with the default remote name 'origin'.

2. Clone your fork. This creates and populates a directory in your local file system.

   git clone https://github.com/<your-username>/windup.git

3. Change to the windup directory.

4. Add the remote upstream repository so you can fetch any changes to the original forked repository.

   git remote add upstream git@github.com:windup/windup.git

5. Get the latest files from the upstream repository.

   git fetch upstream

Fork and Clone the Windup Rulesets Repository

The Windup XML rulesets live in a separate repository. Follow these instructions to fork and clone them.

1. Fork the Windup Rulesets project. This creates the windup-rulesets project in your own Git with the default remote name 'origin'.

2. Clone your fork. This creates and populates a directory in your local file system.

   git clone https://github.com/<your-username>/windup-rulesets.git

3. Change to the windup-rulesets directory.

4. Add the remote upstream repository so you can fetch any changes to the original forked repository.

   git remote add upstream git@github.com:windup/windup-rulesets.git

5. Get the latest files from the upstream repository.

   git fetch upstream

Fork and Clone the Windup Distribution Repository

1. Fork the Windup distribution project. This creates the windup-distribution project in your own Git with the default remote name 'origin'.

2. Clone your fork. This creates and populates a directory in your local file system.

   git clone https://github.com/<your-username>/windup-distribution.git

3. Change to the windup-distribution directory.

4. Add the remote upstream repository so you can fetch any changes to the original forked repository.

   git remote add upstream git@github.com:windup/windup-distribution.git

5. Get the latest files from the upstream repository.

   git fetch upstream