Skip to content

How to contribute to ADE

James Caffrey edited this page Aug 29, 2016 · 1 revision

How to Contribute to ADE

Complete the contributor contribution license

Open MainFrame Project ADE project signup

ADE uses GitHub to manage the code and issues against the code ADE GitHub repository. For people who are familiar with development using GitHub this should look very familiar.

Before making the pull request

To contribute to ADE do the following

  • create a new branch off of the existing branch (develop) with a descriptive name
  • checkout your new branch
  • update the code
  • create or update Junit test for the code change
  • test the code
    • invoke mvn clean package which will build the new code and invoke the appropriate Junit test
    • install the resulting package following instructions in
    • run regression test analysis_comp_test.sh
  • push the updates to you branch
  • issue pull request with a description of the change for the branch you created

Processing after contribution

ADE maintainer (ADEMaint [at] us.ibm.com) will

  • merge the pull request in the develop branch

  • test the code

    • invoke mvn clean package which will build the new code and invoke the appropriate Junit test
    • install the resulting package following instructions in
    • run regression test analysis_comp_test.sh
  • tag the update for the next update of master / next release

  • issue the pull request with description of change to update master

  • merge a set of updates into a new release