Injection dependencies (spring framework)

We use the spring framework to

1. Reduce coupling
2. Increase class coherence and decrease their size (natural application of Single Responsability & Interface seggregation)
3. Increase testability

Page arguments

• Each page has a main object, the target. The id of the target should always use the oid parameter in the request url.

  /do/edit/task?oid=231

  
  
  Rational: this is equivalent to the this reference of java objects. Any operation can assume to find the target id through this request parameter

Exception handling

STANDARD Exception handling

Testing

We rely heavily on testing to ensure sustainable quality of the project. Any new feature is supposed to introduce both unit tests (things are implemented right) and acceptance tests (we implemented the right things). Both set of tests will become our first line of defense to make sure that no regression are introduced as we change the software. This is even more important since it is a open-source software developed with many resources distributed across the world.

A test is not a unit test if: It talks to the database It communicates across the network It touches the file system It can't run at the same time as any of your other unit tests You have to do special things to your environment (such as editing config files) to run it. Instead all external resources should be mocked (using spring makes this easy). Reference: Michael Feathers's definition

Use of todos to mark things to do

Any smells, bugs, inefficiency... that a developer finds but does not have the time to remove should be annotated with a TODO tag. A TODO tag is a comment in the syntax appropriate to the language of the file that will start with the tag followed by a description:

// DEBT: rename m to something more descriptive
public int m() {
   return 0;
}

Agile database management

See STANDARD Agile database management