...
- Code Style
The project's coding style is currently best described by the Eclipse settings in src/build. Here are the major rules:- Four space indents for Java, and 2-space indents for XML. NO TABS.
K&R style braces:
Code Block if (code) { // code } else { // code }- Dont use wildcard imports
- Write Javadocs for public methods and classes. Keep it short and to the point.
- Avoid public instance variables; use accessors.
- Use public methods sparingly; implementation details are not public.
- Logging
We currently use SLF4J for logging. When writing log messages (especially INFO, FATAL, and WARN), consider your audience. Don't over-use INFO; these messages are always logged by default. - Testing
Use JUnit for unit, integration, and system tests. When making changes, please take the time to write tests as needed. We are not looking for 100% coverage here, but the developers will have a lot more confidence in your code if you can show that it works. See the readme.txt in the root of the source tree as a jumping-off point for adding your tests to one of the suites. Here's a brief description of the basic types of tests we run:- Unit - Tests a single class. These tests are typically very quick to run, and therefore get the most use by developers. Unit tests don't touch the disk or interface with classes other than mocks. If you can cover a scenario adequately in a unit test, you should prefer implementing it as such (and not as an integration or system test)
- Integration - Tests multiple classes working together. May touch disk or interact with a "test" database.
- System - Works against a running Fedora server in a given configuration. These are "block box" style tests against the public APIs of Fedora. These take much longer to run than unit or integration tests because they require significant setup.
...
See the Fedora Release Process document.
Development Tools
If you find a need for licensed software to do your Fedora development (e.g. an IDE, Java profiler, other tool), contact DuraSpace (email: sysadmin at duraspace.org) and we can try to obtain a license. Many non-free, licensed development tools offer free "open source" licenses. Some tools that DuraSpace has already obtained committer licenses for include: IntelliJ IDEA and YourKit Java profiler.