Skip to content

JPII/guidelines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

guidelines

A brief summary of the organization guidelines. Each section is further explained in the appropriate directory.

Coding Standards

  • Javadocs are vital and must be used for every public facing method. They must note any possible raised exception, the return result (if any), the method arguments (if any) and a description of the method - this is a minimum, more is better.
  • All public facing methods must be input validated and raise exceptions if something is wrong. It's better to catch a bug that may happen than let it grow into something worse.
  • No trailing whitespaces. Use sun/oracle coding standards if in doubt.
  • Absolutely no already-implemented classes or methods. Use interfaces, and have util classes.
  • Brackets do not get their own line, unless they are ending a block
  • This is only a summary, see http://geosoft.no/development/javastyle.html for a full list
  • Alternatively, use http://www.leepoint.net/notes-java/principles_and_practices/style/style-practices-summary.html for a summary

Issues

  • Used to track features, issues, and anything else that needs to be done
  • Each issue should be labeled, assigned, and given a milestone as soon as possible
  • Assignees are responsible for all of their issues in terms of deadlines, etc.
  • Milestones should be created with a defined goal and deadline

Legal

  • Source code will be licensed under GNU General Public License v3
  • Open sourced projects by a third party will be forked if possible

About

Organization guidelines

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors