How to contribute?

You can contribute to ProM by creating your own ProM packages. To ease the development and distribution of your packages we offer:

  • to store your packages in our ProM workbench at GitHub,
  • to automatically build and release your package after you have committed changes to it, and
  • to distribute the latest release of your package through our package repository.

Nevertheless, if you want, you can do this all by yourself. Simply check out any existing package repository from our ProM workbench at GitHub, and take it from there.

First steps

  1. Install some Java IDE with SVN functionality, like ​Eclipse with ​Subclipse and ​IvyDE.
    • We strongly recommend to use Java 8 or Java 11 to develop plugins in ProM, as ProM uses a feature that works with Java 8 but that does not work with recent versions of Java (like Java 17).
    • When using Java 9 or later, please make sure to use version 6.10.110 of the ProM framework (available in the ProM Nightly Builds from March 31, 2020). This version of the ProM framework is able to scan your current package for the plugin annotations. If you are using an earlier version of the ProM framework, you can only work on existing plugins, but you cannot add new plugins or rename existing ones.
    • To install IvyDE, use the following steps:
      1. In Eclipse, choose Help -> Install New Software -> Add … -> ​http://www.apache.org/dist/ant/ivyde/updatesite
      2. Select the IvyDE plugin and install.
      3. You may have to restart Eclipse after install.
    • To install Subclipse, use the following steps:
      1. In Eclipse, choose Help -> Install New Software -> Add … -> ​https://subclipse.github.io/updates/ (used to be ​https://dl.bintray.com/subclipse/releases/subclipse/latest/)
      2. Choose Core SVNKit Library and Subclipse and install.
      3. You may have to restart Eclipse after install.

You can then clone a package repository from GitHub, and open it in Eclipse. To run the project for the first time, please do the following:

  1. Right-click the “ProM Package Manager (<package>).launch” file and select “RunAs / ProM Package Manager (<package>)”. This starts the ProM 6 Package Manager.
  2. Go to the “Not installed” tab (left-hand side).
  3. Select “RunnerUpPackages” in the list, and select “Install” at the right-hand side. This will install the typical set of packages (which contain most of the plug-ins).
  4. Close the Package Manager.
  5. Right-click the “ProM with UITopia (<package>).launch” file and select “RunAs / ProM with UITopia (<package>)”. This starts ProM 6.

For later runs, you only need to perform step 5.

If you want to add plug-ins to your local version of ProM 6, you can add them to the Workshop project. If you have done this correctly and if you run ProM 6 by using step 5 as mentioned above, your plug-in should show in ProM 6. Note that thses plug-in swill not be available to tohers, they can only be run on your computer.