Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description of what graph means #15

Merged
merged 1 commit into from Sep 7, 2013
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -3,6 +3,25 @@ Hopefully-meaningful Metrics

Based on Michael Feathers' [recent work](http://www.stickyminds.com/sitewide.asp?Function=edetail&ObjectType=COL&ObjectId=16679&tth=DYN&tt=siteemail&iDyn=2) in project churn and complexity.

Here is how to read the graph (extracted from the above article):

* The upper right quadrant is particularly important.
These files have a high degree of complexity, and they change quite frequently.
There are a number of reasons why this can happen.
The one to look out for, though, is something I call runaway conditionals.
Sometimes a class becomes so complex that refactoring seems too difficult.
Developers hack if-then-elses into if-then-elses, and the rat’s nest grows. These classes are particularly ripe for a refactoring investment.

* The lower left quadrant. is the healthy closure region.
Abstractions here have low complexity and don't change much.

* The upper left is what I call the cowboy region. This is complex code that sprang from someone's head and didn't seem to grow incrementally.

* The bottom right is very interesting. I call it the fertile ground.
It can consist of files that are somewhat configurational, but often there are also files that act as incubators for new abstractions.
People add code, it grows, and then they factor outward, extracting new classes. The files churn frequently, but their complexity remains low.


Installation
------------

Expand Down