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 fully understand and appreciate the value, the reasoning and the learning behind the different types of analysis I highly recommend 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: chapters 3 and 4
  • Complexity trend: chapter 6
  • Logical Coupling : chapters 7, 8 and 14
  • System evolution: chapters 9, 10 and 14

• Social analysis

  • Commit message: chapter 11
  • Developer coupling and communication: chapters 12 and 15
  • Developer effort and knowledge distribution: chapter 13

Run the following commands to list or get usage information on all the available 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.

This wiki also includes a Troubleshooting guide and a Frequently Asked Questions pages, that I will keep up to date as I collect issues and questions raised by users of code-forensics.