...
- All public classes and methods should have informative Javadoc comments.
- Do not use @author tags.
- Code should be formatted according to Sun's conventions, with two exceptions:
- Indent two (2) spaces per level, not four (4).
- Line length limit is 100 chars, instead of 80 chars.
- Contributions should not introduce new Checkstyle violations.
- Check for new Checkstyle violations by running
ant mvn checkstyle:checkstyle-aggregate
, and then inspect the results in the buildthetarget/checkstylesite
directory. (TODO implement on maven) - 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 must implement a class that extends
junit.framework.TestCase
and whose class name starts withTest
. - Define methods within your class whose names begin with
test
, and call JUnit's many assert methods to verify conditions; these methods will be executed when you runmvn test
. - You can run all the unit tests with the command
mvn test -Phadoop-1
, or you can run a specific unit test with the commandmvn test -Phadoop-1 -Dtest=<class name without package prefix>
(for example:mvn test -Phadoop-1 -Dtest=TestFileSystem
).
- You must implement a class that extends
...