JHOCR Contribution

Contribution

There are many ways you can help us to improve this project.

• Use this project to convert your documents.
• By submitting an issue and describing your problem or giving us feedback: https://code.google.com/p/jhocr/issues/list
• By adopting this project and helping to improve with your java skills, just contact us.
• You can like the JavaHOCR page &/ spread the word about this project.
• Contributing Open Source Code

Javadoc

Be sure to add java documentation to your code before commiting the code via svn. Here some useful links:

• Wikipedia Javadoc entry
• How to Write Doc Comments for the Javadoc Tool
• Best practice example

Code Format

Be sure to check your code before checking the code. Only functional code and formatted code:

• Use our eclipse-code-formatter-profile.xml see r24
• No @author tag needed, see Apache removes author tag and Javadoc @author tag good practices
• When to commit? Commit only when you have successfully unit tested the given function/module/functionality and you are reasonably assured that it is ready for integration or system testing, see: When to commit code?

Java Best Practices

Worth reading and practicing:

• Be wary of letting constructors throw exceptions