Developer Space

Overview

This page is a developer space for this project.

Developer Accounts Needed

Software Setup

Project Resources

Sprints and Milestones and Meeting Notes

 

UI Testing Scripts

Style Rules

  • Use "uib-tooltip" for more info (no action)
  • When using ng-click, use "title" for buttons and for icons. 

 

Diagrams

Coding Standards

Only commit projects when the following things are the case:

  • General
    • Declare variables as final by default.
  • Non-parent maven projects should not directly reference versions
    • where absolutely necessary, they should use variables for version info
  • All java errors and warnings should be removed.
  • Javadoc should be added and fleshed out
  • Imports should be properly organized and code is formatted
  • No "TODO" sections should remain in the code - create additional tickets if necessary
  • Service (JPA) calls should take parameters in general (except "add" and "update" calls).
  • Swagger annotations should be up to date and reflect current state of REST APIs
  • Exception handling "catch" clauses should always properly handle errors
    • Low-level code (e.g. services) should NEVER handle exceptions, they should show them
    • The right level at which to handle an error is any code that is capable of showing the user an error message.
  • System.out and System.err calls should be replaced by Logger.getLogger... calls
  • Remove any explicit package names, class names, file paths, database names, or other hard coded environment information that makes assumptions about what exists and where it exists.  All of this should be data-driven (either from config files or from the database.

Git Best Practice