JGenerator coding conventions

Java

  • Read and follow the Java coding conventions when working on this project. Any non-conformant source will be rejected.
  • Make sure the JGenerator license appears at the top of each new source file. Use your own name as the copyright holder.
  • All source code added to the project must be licensed under Apache style license. Any non-conformant code will be rejected.
  • Use data member names that are whole words. Avoid acronyms or abbreviations, like "curNum" or "lvt". No one is going to know what those are used for. Names should be as self-documenting as possible.
  • Write lots of comments. This shows that you know what you are doing and helps others follow what you did. Avoid stating the obvious and use proper English. Comments like "ctor." are not appropriate comments.

Any contributed code that strays from the conventions described above will have to be removed from the CVS repository until such time as the code is made conformant. We cannot take non-free, unreadable, or sloppy code.

CVS

  • Set the CVSREAD environment variable to strictly enforce editing of only files you have marked for edit using 'cvs edit'. This is only a suggestion, not a requirement.
  • Do not install class files or makefiles. Use the .cvsignore file for this purpose.
  • If you do not know what a file is used for, leave it alone.
  • Use the CVS commit message to explain what it is you are submitting. If you are fixing a bug, describe the bug and what you did to fix the problem. If the bug has been entered into the bug database, please refer to the bug by number.