Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 3. Additional Resources

3.1. Review the Windup Quickstarts
Copy link

The Windup quickstarts provide working examples of how to create custom Java-based rule add-ons and XML rules. You can use them as a starting point for creating your own custom rules.

You can download a ZIP file of the latest released version of the quickstarts. Or, if you prefer to play around with the source code, you can fork and clone the windup-quickstarts project repository.

3.1.1. Download the Latest Quickstart ZIP
Copy link

To download the latest quickstart ZIP file, browse to: https://github.com/windup/windup-quickstarts/releases

Click on the most recent release to download the ZIP to your local file system.

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

  1. Click the Fork link on the Windup quickstart GitHub page to create the project in your own Git. The forked GitHub repository URL created by the fork should look like this: https://github.com/YOUR_USER_NAME/windup-quickstarts.git

  2. Clone your Windup quickstart repository to your local file system: 

    git clone https://github.com/YOUR_USER_NAME/windup-quickstarts.git
    Copy to Clipboard Toggle word wrap

  3. This creates and populates a windup-quickstarts directory on your local file system. Navigate to the newly created directory, for example 

    cd windup-quickstarts/
    Copy to Clipboard Toggle word wrap

  4. If you want to be able to retrieve the lates code updates, add the remote upstream repository so you can fetch any changes to the original forked repository. 

    git remote add upstream https://github.com/windup/windup-quickstarts.git
    Copy to Clipboard Toggle word wrap

  5. To get the latest files from the upstream repository. 

    git reset --hard upstream/master
    Copy to Clipboard Toggle word wrap

3.2. Get Involved
Copy link

3.2.1. How can you help?
Copy link

To help us make Windup cover most application constructs and server configurations, including yours, you can help with any of the following items. Many require only a few minutes of your time!

  • Send an email to windup-users@lists.jboss.org and let us know what should Windup migration rules cover.
  • Provide example applications to test migration rules.

  • Identify application components and problem areas that may be difficult to migrate.

    • Write a short description of these problem migration areas.
    • Write a brief overview describing how to solve the problem migration areas.
  • Try Windup on your application. Be sure to report any issues you encounter.

  • You can contribute to the Windup rules repository.

    • Write a Windup rule to identify or automate a migration process.
    • Create a test for the new rule.
    • Details are provided in the Windup Rules Development Guide.

  • You can also contribute to the project source code.

    • Create a core rule.
    • Improve Windup performance or efficiency.
    • See the Windup Core Development Guide for information about how to configure your environment and set up the project.

Any level of involvement is greatly appreciated!

3.4. Known Windup Issues
Copy link

Windup known issues are tracked here: Open Windup issues

3.5. Report Issues with Windup
Copy link

Windup uses JIRA as its issue tracking system. If you encounter an issue executing Windup, please file a JIRA Issue.

3.5.1. Create a JIRA Account
Copy link

If you do not yet have a JIRA account, create one using the following procedure.

  1. Open a browser to the following URL: https://issues.jboss.org/secure/Dashboard.jspa
  2. Click the Sign Up link in the top right side of the page.
  3. Enter your email address and click the Confirm address button.
  4. Follow the instructions sent to your email address.

3.5.2. Create a JIRA Issue
Copy link

  1. Open a browser to the following URL: https://issues.jboss.org/secure/CreateIssue!default.jspa.

    • If you have not yet logged in, click the Log In link at the top right side of the page.
    • Enter your credentials and click the LOGIN button.
    • You are then redirected back to the Create Issue page.

  2. Choose the following options and click the Next button.

    • Project

      For core Windup issues, choose Windup: (WINDUP).

      For issues with Windup rules, choose: Windup rules (WINDUPRULES).

    • Issue Type: Bug

  3. On the next screen complete the following fields:

    • Summary: Enter a brief description of the problem or issue.
    • Environment: Provide the details of your operating system, version of Java, and any other pertinent information.
    • Description: Provide a detailed description of the issue. Be sure to include logs and exceptions traces.
  4. Click the Create button to create the JIRA issue.
  5. If the application or archive causing the issue does not contain sensitive information and you are comfortable sharing it with the Windup development team, attach it to the issue by choosing More Attach Files. You are provided with an option to restrict visibility to JBoss employees.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat