milestone 9

Milestone 9

Action Plan

Quality Criteria and Inspection Items (Add other appropriate items for our product)

1. Completeness(of reflection by code of requirements)
   1. Each such method has appropriate parameters
2. Consistency (of layout, name choice, and code organization)
   1. Placement of braces ({ and }) done consistently throughout.
   2. Indentation is used, consistently, to indicate block structure within braces.
   3. Block comments precede the code they describe.
   4. The same names or abbreviations are used consistently for the same concept (_e.g. _not next, nextNode, and nxtn in three places in the same class).
3. Coding Style
   1. Correct function declarations
   2. Semicolons after each line of code
   3. Let instead of var
   4. Single property single line object property declarations
4. Efficient Processing (using as little processing time as is reasonable)
   1. Loops contain complex code, or other loops, only when necessary.
   2. Array processing (especially search) contains loop exit code to execute when the condition is found.
5. Efficient Storage
   1. All local and instance variables are actually used somewhere.
   2. limited global variables
6. Simplicity
   1. No redundant code, extract to a function
   2. Math expressions, control expressions (in ifs, whiles, fors, and switches) are as simple as possible.
   3. Standard JS usage.
   4. Variables declared as close as possible to where they are used
7. Self-Description
   1. Comments are provided whenever the purpose or reason for doing something in the code is obscure.
   2. Comments are provided to describe every method, however briefly.
   3. Comments are provided to describe the purpose, restrictions, and relationships between all instance variables in a class.
   4. All names are chosen well and consistently to reflect their usage and purpose.
   5. Constants (static final) are used instead of magic numbers. (_e.g. _Don't write 42, write static final ULT_ANS = 42; and then use ULT_ANS instead.)
   6. Booleans are not compared to boolean constants. (_e.g. _if (!found) is preferred to if (found == false)).
8. Reusability
   1. Public methods are as general-purpose as is consistent with the design.
   2. Public method headers do not reveal the known usage of the class by code outside the class.
9. Modularity
   1. Instance variables are not public.
   2. Variables are declared as locally as possible.
   3. Public method headers don't reveal the internal design of the class.
   4. System.exit is not called directly.
10. Extra
    1. Generated files should not be in git repo
    2. Old uncommented code should be removed
    3. Coding should be done in a way to increase cohesion and decrease coupling

Findings Report

Inspector’s Name: Lucas Merilees

Inspectee's Name: Michael Wong

Date Started: March 11th 2020

Date Completed: March 13th 2020

Project Name:Crab My Receipt

Time Report:

    Time spent on Familiarization with the Code: 30 minutes


    Time spent on Filling in Findings Report: 1 hour


    Time spent on Actual Inspection: 1 hour

Findings:

Findings Report

Inspectee's Name: Jorgen Wiebe

Inspector’s Name: Jeremie Michaud

Date Started: March 11th 2020

Date Completed: March 13th 2020

Project Name:Crab My Receipt

Time Report:

    Time spent on Familiarization with the Code: 30 minutes


    Time spent on Filling in Findings Report: 1 hour


    Time spent on Actual Inspection: 1 hour

Findings: Several copy paste errors so the line numbers are similar in other files

Findings Report

Inspector’s Name: Michael

Inspectee: Lucas

Date Started: March 10, 2020

Date Completed: March 13, 2020

Project Name: CrabMyReceipt

Time Report:

    Time spent on Familiarization with the Code: 30 min


    Time spent on Filling in Findings Report: 1 hours


    Time spent on Actual Inspection: 2 hours

Findings:

Further Comments from the Inspection of this Class:

Findings Report

Inspector’s Name: Jorgen Wiebe

Inspectee: Jeremie Michaud

Date Started: March 13, 2020

Date Complete: March 13, 2020

Project Name: Crab My Receipt

Time Report:

Time spent on familiarization with the Code: 10min

Time spend on FIlling in Findings Report: 50min

Time spent on Actual Inspection: 50min

Findings:

Further comments: Good job!