...
- For Eclipse:
- Go to Preferences -> Java -> Code Style -> Formatter; Import eclipse-styles.xml; Apply.
- In addition update save actions: Java -> Editor -> Save Actions; Check the following: Perform the following actions on save; Format Source Code; Format edited lines.
- For Intellij:
- Go to Settings -> Editor -> Code Style -> Java -> Scheme; Click manage; Import eclipse-styles.xml; Apply.
- For Eclipse:
- Contributions should not introduce new Checkstyle violations.
- Check for new Checkstyle violations by running
mvn checkstyle:checkstyle-aggregate, and then inspect the results in thetarget/sitedirectory. It is possible to run the checks for a specific module, if themvncommand is issued in the root directory of the module. - If you use Eclipse you should install the eclipse-cs Checkstyle plugin. This plugin highlights violations in your code and is also able to automatically correct some types of violations.
- Check for new Checkstyle violations by running
- Contributions should pass existing unit tests.
- New unit tests should be provided to demonstrate bugs and fixes. JUnit is our test framework:
- You should create test classes for junit4, whose class name must start with a 'Test' prefix.
- You can run all the unit tests with the command
mvn test, or you can run a specific unit test with the commandmvn test -Dtest=<class name without package prefix>(for example:mvn test -Dtest=TestFileSystem). - After uploading your patch, it might worthwhile to check if your new test has been executed in the precommit job.
...