Contribution

The JOML team is always happy about contributions from other GitHub users in the form of bug fixes, new functionality/enhancements and test cases.

How you can contribute

First we request you to make an own fork of JOML using your own GitHub user. There, you can make any changes you like. After you are content with your changes, you can use GitHub's "Pull Request" feature to have your changes being integrated into the JOML repository.

If you plan to create a fork of JOML with changes you do not wish to have pulled back, it is good to have a dedicated "pull" branch containing only the changes/commits that you want to have pulled back into JOML. This is because GitHub cannot create pull requests on dedicated commits, but only on the current state of a whole branch.

How to write test cases

JOML uses the JUnit test framework for all of its unit tests. In order to remain Java 1.4 compatible, it uses the last version of JUnit 3, which as of this date is 3.8.2. Most IDEs, such as Eclipse, have built-in support for JUnit to let you develop unit tests and execute them from within the IDE.

Make sure that all unit tests pass before committing them to the git branch which you use for the Pull Request.

Also when creating new test classes and test methods, make sure to follow Maven's and JUnit's naming conventions:

• Test classes must either start or end with Test
• Test classes must extend junit.framework.TestCase
• Methods in a test class must begin with test