Skip to content

Development Process

Shane Avery Sistoza edited this page Mar 6, 2018 · 12 revisions

Information about the Development Process goes here.

Discuss general project organization, discuss the three initial teams (dashboard, calendar, curriculum editor), and how they merged and split into the 3 other teams (css overhaul, database pruning, auxiliary teams)

Git Process

Useful Commands

Show Commit Structure: git log --graph --decorate --pretty=oneline --abbrev-commit

  • Press q to quit viewing it.

Java Guides

  1. Javadocs on all methods.
    • In this case controller methods for 1712-steve batch.
  2. Interfaces for the service layer.
    • Not a part of scope for 1712-steve batch.
  3. Follow Java naming conventions.
    • Methods and variables should be camelCased.
    • Classes should be PascalCased.
    • Final variables should be UPPERCASED.
  4. jUnit Testing
    • Imported from the previous iteration.
  5. No Sysouts
  6. No Unnecessary Comments
    • Commented code that is no longer in use.

Angular Guides

  1. Angular docs
  2. Files Folders
    • Folders should be kebabcase.
    • Components should be in the bam/components folder.
    • Services should be in the bam/services folder.
    • Models should be in the bam/models folder.
  3. Java style naming conventions.
  4. Routes are lowercase.

Additional Info.

When building into production their will be other errors that come up. Here are some of the most commons ones to check with the git process:

  1. The import library is case-sensitive. Ex: import { Observable } from 'rxjs/Observable'.
    • The O in 'rxjs/Observable' must be capitalized.
    • However, import { of } from 'rxjs/observable/of', the o here must be lowercase.
  2. The state or field should be public in the ts file if it is being used in the html file.

Clone this wiki locally