Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

Name

Technical Debt Plugin

Authors

Freddy Mallet, Olivier Gaudin

Jira

http://jira.codehaus.org/browse/SONARPLUGINS/component/13850

Most Recent Version

0.2

State

Under development

License

LGPL v3

Sources

http://svn.codehaus.org/sonar-plugins/trunk/technical-debt/

Download

Latest stable : technical-debt-0.2.jar
Called for a vote : technical-debt-0.3-SNAPSHOT.jar

Compatibility with Sonar

Plugin versions

1.8

1.9

1.10

0.1

(tick)

0.2

(tick)

0.3-SNAPSHOT

(tick)

Description / Features

The Technical Debt plugin is an unified metric combining quality axes (Duplication, Violations, Complexity, Coverage, Documentation).

The basic principle is to calculate how much it would cost to clean all defects from every axis (no violation, no duplication...) : that means reimbursing the Technical Debt. 

The plugin contains 4 indicators :

  • The cost of the debt in $$
  • The cost of the debt in man days
  • The debt ratio (%)
  • The repartition of the debt across the axis

A note indicates at the bottom of repartition if coverage measure was not available (light projects).

Objectives of the plugin


  • give helicopter view on the global quality of a project
  • compare projects
  • understand where the cost to improve lies
  • communication tool with outside to explain why quality improvement is required

How is all this calculated

Full details of calculation is available here.

The debt ratio

The debt ratio enables to compare projects. Indeed having $ 10,000 debt on a "small" project does not mean the same as the same debt on a big project. The debt ratio consists in comparing the actual debt with the total possible debt for the project (the project has got 100% lines duplicated, 0% coverage...)

Drill down

Clicking on the debt brings to the usual drill down page showing modules / packages / classes most impacted

Configuration

Most of the settings / default values can be configured by going to Configuration -> Settings -> Technical Debt.

Usage & Installation

  1. Copy the jar into /extensions/plugins/ directory
  2. Restart Sonar Web server
  3. Launch a new quality analysis and the technical debt metrics will be fed

Known limitations

A significant improvement to the would be to gather manual measures : see SONARPLUGINS-91

Having a real cost to resolve for each rule would add a lot accuracy

Changelog

Technical Debt 0.3 :

Loading
Type Key Summary Assignee Reporter Priority Status Resolution Created Updated Due
Bug SONARPLUGINS-184 Help button does not show up on non-standalone Sonar installations Olivier Gaudin Josh McFarlane Minor Closed Fixed Aug 19, 2009 Aug 20, 2009
Task SONARPLUGINS-160 Update Documentation Olivier Gaudin Olivier Gaudin Major Closed Fixed Jul 27, 2009 Aug 18, 2009
Improvement SONARPLUGINS-147 Do not insert a measure when zero Olivier Gaudin Olivier Gaudin Major Closed Fixed Jul 18, 2009 Aug 18, 2009
Task SONARPLUGINS-145 Upgrade to Sonar 1.10 API Olivier Gaudin Olivier Gaudin Major Closed Fixed Jul 16, 2009 Aug 18, 2009
Improvement SONARPLUGINS-113 Display the formula in the dashboard as a tooltip or with a link Unassigned Olivier Gaudin Major Closed Fixed Jun 08, 2009 Aug 18, 2009
Improvement SONARPLUGINS-98 Axes should not be shown in the repartition when value is zero Olivier Gaudin Olivier Gaudin Major Closed Fixed May 28, 2009 Aug 18, 2009
Improvement SONARPLUGINS-96 Use piechart defined in the API Olivier Gaudin Olivier Gaudin Major Closed Fixed May 27, 2009 Aug 18, 2009
New Feature SONARPLUGINS-94 Add a density dimension to the Technical Debt Olivier Gaudin Olivier Gaudin Major Closed Fixed May 26, 2009 Aug 18, 2009

Technical Debt 0.2 :

Loading
Type Key Summary Assignee Reporter Priority Status Resolution Created Updated Due
Improvement SONARPLUGINS-108 Set 80% as an objective for code coverage Olivier Gaudin Olivier Gaudin Major Closed Fixed Jun 06, 2009 Jul 18, 2009
Improvement SONARPLUGINS-102 Improve the widget looking when no debt has been calculated Olivier Gaudin Olivier Gaudin Major Closed Fixed May 30, 2009 Jun 06, 2009

  • No labels