Skip to content

Task Cross Reviewing

Jump to bottom Edit New page
caracciolo edited this page Nov 10, 2015 · 8 revisions

1. Write: Cross-reviewing

The assignment consists of 2 points:

  1. Write a constructive and useful review of the project assigned to your team using the checklist template reported below. The review should serve as guideline to improve both code and design. Avoid general statements and bring concrete examples.

  2. Pick a class of choice from the controller package and analyze its code. Does the class have too many responsibilities ? Is there some logic that should be moved to another class ? If so, why ?

The Review must be saved in your repository as: /Review/ReviewForTeamX.[txt|doc|pdf]
(where X is the team you reviewed)

Project checkout

For this assignment, you will look into the repository of another team. The repository assigned to your team is assigned based on the formula: ((i+3)mod 9)+1

That is: 1 -> 5, 2 -> 6, 3 -> 7, 4 -> 8, 5 -> 9, 6 -> 1, 7 -> 2, 8 -> 3, 9 -> 4

After cloning the assigned repo, checkout v1.0:

git clone https://github.com/unibe-ese/ese2015-team**.git
git checkout tags/v1.0

Checklist template

Use the following checklist template for writing your review:

Design

  • Violation of MVC pattern
  • Usage of helper objects between view and model
  • Rich OO domain model
  • Clear responsibilities
  • Sound invariants
  • Overall code organization & reuse, e.g. views

Coding style

  • Consistency
  • Intention-revealing names
  • Do not repeat yourself
  • Exception, testing null values
  • Encapsulation
  • Assertion, contracts, invariant checks
  • Utility methods

Documentation

  • Understandable
  • Intention-revealing
  • Describe responsibilities
  • Match a consistent domain vocabulary

Test

  • Clear and distinct test cases
  • Number/coverage of test cases
  • Easy to understand the case that is tested
  • Well crafted set of test data
  • Readability
Add a custom footer
Add a custom sidebar
Clone this wiki locally