Want to contribute? Great! First, read this page (including the small print at the end).
Before we can use your code, you must sign the Google Individual Contributor License Agreement (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things—for instance that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase. Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.
FreeBuilder is built using Gradle. The following commands are especially useful:
./gradlew eclipse
— Creates two Eclipse projects,freebuilder
andfreebuilder-test
. You will need both JDK 6 and 8 installed, as for complex reasons JDK 7/8 will not compile the freebuilder project in Eclipse, while freebuilder-test requires JDK 8 to test lambdas. Go to Preferences > Java > Installed JREs in Eclipse to configure it with the location of your JDK installations../gradlew check
— Runs all unit and integration tests. These are automatically run against every PR, and will need to pass before any contribution will be accepted.
All submissions, including submissions by project members, require review. We use Github pull requests for this purpose.
Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.