Home

code-forensics Wiki

This wiki is a work in progress and documents how to configure and run code-forensics to produce code analysis reports and to visualise the results in the form of diagrams.

This documentation gives only a brief description of each single analysis performed by code-forensics. In order to to fully understand and appreciate the value, the reasoning and the learning behind the different types of analysis I highly recommended to read the book Your Code as a Crime Scene by Adam Tornhill, whose work this software was largely inspired by.

Here is the list of the analyses available through code-forensics and the corresponding section of the book where they are explained in detail:

• Code analysis

  • Hotspot analysis: chapters 3 and 4
  • Complexity trend analysis: chapter 6
  • Coupling analysis : chapters 7, 8 and 14
  • System analysis: chapters 9, 10 and 14

• Social analysis

  • Commit message analysis: chapter 11
  • Developer coupling and communication analysis: chapter 12
  • Developer effort distribution analysis: chapter 13

Run the following commands to list or get usage information on all the availabe analysis:

$ gulp list-analysis-tasks: print the list of all the top level analysis tasks

$ gulp help --taskName=<task-name>: display information and usage on a particular task.