Skip to content

Commit 0143ef6

Browse files
Adding to README.md
1 parent 251451f commit 0143ef6

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Disharmony Ranker
22

3-
This is a tool for Java codebases that will help you identify the God Classes you should refactor first.
3+
This tool for Java codebases will help you identify the God Classes you should refactor first.
4+
The graph generated in the report will look similar to this one:
5+
![image info](./RefactorFirst_Sample_Report.png)
46

57
## There are several ways to run the analysis on your codebase:
68

7-
Once the report is generated, you will find a table with the output in **target/site/refactor-first-report.html**. The classes you should refactor first are at the top.
9+
Once the plugin is finished executing (it may take a while for large / old codebases), open the file **target/site/refactor-first-report.html** in the root of the project. It will contain a graph similar to the one above, and a table that lists God classes as well as the recommended order they should be refactored in. The classes you should refactor first are at the top.
810

911
### From The Command Line
1012
Run the following command from the root of your project (the source code does not need to be built):
@@ -49,15 +51,16 @@ This plugin will work on both single module and multi-module Maven projects.
4951

5052
This tool is based on the paper **[Prioritizing Design Debt Investment Opportunities](https://dl.acm.org/doi/10.1145/1985362.1985372)** by Nico Zazworka, Carolyn Seaman, and Forrest Shull
5153

52-
There is still much to be done. Your feedback would be greatly appreciated.
54+
There is still much to be done. Your feedback would be greatly appreciated!
5355

5456
## Limitations
5557
* This plugin only works with Java 8 projects at this time
5658

5759
## Future Plans
60+
* Improve logging.
5861
* Move from JUnit 4 to Junit 5. Junit 5 is lacking the support for temporary files that JUnit 4 provides.
5962
* Use Maven's Guice to autowire dependencies.
60-
* Incorporate more disharmonies from Object Oriented Metrics In Practice.
63+
* Incorporate more disharmonies from Object Oriented Metrics In Practice (Lanza and Marinescu, 2004).
6164
* Support Java 11
6265

6366

RefactorFirst_Sample_Report.png

144 KB
Loading

0 commit comments

Comments
 (0)