MBAT/SHIVA SVN Repository Check-in Policy

To make sure the code being checked into the source code repository meeting some standards:

• Only check-in code that contains no compiling error. This includes checking in all the necessary library files.

• Optimize imports before checking-in.

• Remove all warnings before checking-in. The exceptions are
  
  1. Serializable class without serial/VersionUID
     This warning is unnecessary since most GUI components are serializable due to inheritance, but not actually involved in serialization.
     (In eclipse, you may can turn this warning off under Preferences->Java->Compiler->Errors/Warnings->Potential programming problems).
  2. Local variables never read.
     This warning is work around a 3rd party code (namely jwarping/). Also debugging code commented out sometimes may depend on these variables.
  3. Unused local or private member.
     Reflection based programs sometimes sets and retrieves private members. These members are declared private to hide the implementation detail from regular programs.
     (In eclipse, you may turn off warnings 2 and 3 off under Preferences->Java->Compiler->Errors/Warnings->Unnecessary code)

• All classes, functions and variables meet the Java naming convention guide line. For variables, prefixes and/or suffixes are allowed.

• Give a brief description for code being checked-in in the commit message.

• For a new directory directly under /, src/, and plugins_src/, write a brief description of what it does under LONI Subversion Repository Structure.