Development guide and contribution policy - Agilefant/agilefant GitHub Wiki

How to set up your development environment

In a nutshell (for longer instructions, read this):

• Install Java, Mysql, Apache Maven, Tomcat, and Eclipse.

• Add Maven Integration to Eclipse:

• m2e - Maven Integration for Eclipse

• m2e - slf4j over logback logging

• m2e-wtp - Maven Integration for WTP (Incubation)

• Add Jrebel to Eclipse (optional)

• JRebel

• JRebel for Java EE

• JRebel m2eclipse

• Create Tomcat server in Eclipse, add agilefant to the server

• Clone agilefant from https://github.com/Agilefant/agilefant

• Import the project to Eclipse

• Install third party programs needed for Agilefant

• Create database for Agilefant in Mysql

• Start the server. Agilefant will be running at http://localhost:8080/agilefant

Contributing

• Read the general and commit policies below
• Create a thread to our forum explaining what you plan to implement
• Create a GitHub repository, fork the latest release, implement your change and do a pull request

General policy

All changes and contributions to the Agilefant repository are under the Agilefant license. Contributors will be credited at the contributors.

By issuing a pull request or sending your changes over in any other form, you accept the Agilefant license to apply to your changes.

Pull request policy

• The necessary code has been written
• The code has been re-factored
• The implemented story has been tested ad-hoc
• Unit tests have been written and all tests are passing
• The commit contents are compatible with the Agilefant license