Developers
How to Contribute
If you want to contribute to this project just look for current open issues. Please let know in the comments of the issue that you are going to pick it up because somebody could already work on it. In the end just send the pull request. By the way the feature that you are going to work on should not just solve your particular problem. It should be extendable and configurable. The github issues is the best place to debate on the feature and discuss how it should be implemented.
If you would like to make a change to the Galen Framework website (
http://galenframework.com) you can do it here
https://github.com/galenframework/galenframework.com
If you want to improve the functionality related to image comparison or color scheme - you have to first make a pull request to
rainbow4j as all the core code for comparing images, applying filters and calculating the color scheme is located in it. After this it will be released to sonatype central repository and will be available as maven dependency.
Building
This project is based on Maven. You can use both Intellij or Eclipse for it. It is being developed in Linux so all the assembling scripts are in bash. In order to assemble the dist with zip archives just run
./makeDist.sh and it will create a dist folder with both binary and source folders and it will prepare zip archives there as well. If you want to quickly test the concept and install galen right after the assembling you can use script
./assembleAndInstall.sh. It uses makeDist.sh and then just invokes sudo
./install.sh
Testing
There are two levels of testing. The first one is just the regular mvn clean test. But as there is a lot of Javascript code - you need Mocha. The tests can be directly executed via maven by using npm under the hood. If you have
npm installed then you can just simply run
mvn test command and that will trigger Jslint tests, Mocha tests and Java TestNG tests.