Skip to content

Commit 020f87c

Browse files
Update README.md
1 parent 8757a3b commit 020f87c

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,32 @@ Add the following to your project in the reports section:
4545
</reporting>
4646
```
4747

48-
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.
48+
## Viewing the Report
49+
Once the plugin is finished executing (it may take a while for a large / old codebase), 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 in the recommended order that they should be refactored. These are the clasess that are the easiest to refactor while also having the biggest positive impact to team productivity.
4950

50-
This plugin will work on both single module and multi-module Maven projects.
51+
52+
## Additional Details
53+
This plugin will work on both single module and multi-module Maven projects that have a typical Maven project layout.
5154

5255
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
5356

54-
There is still much to be done. Your feedback would be greatly appreciated!
55-
5657
## Limitations
57-
* This plugin only works with Java 8 projects at this time
58+
* This plugin has only been confirmed to work with Java 8 projects at this time.
59+
* There isn't much logging (yet).
60+
* My time. This is a passion project and has been done in my spare time.
61+
62+
## Feedback and Collaboration Welcome
63+
There is still much to be done. Your feedback and collaboration would be greatly appreciated in the form of feature requests, bug submissions, and PRs.
64+
If you find this plugin useful, please star this repository and share with your friends & colleagues and on social media.
5865

5966
## Future Plans
6067
* Improve logging.
6168
* Move from JUnit 4 to Junit 5. Junit 5 is lacking the support for temporary files that JUnit 4 provides.
6269
* Use Maven's Guice to autowire dependencies.
70+
* Add a Gradle plugin.
71+
* Incorporate bug counts per God class to the Impact (Y-Axis) calculation.
6372
* Incorporate more disharmonies from Object Oriented Metrics In Practice (Lanza and Marinescu, 2004).
6473
* Support Java 11
6574

6675

76+
#Thank You! Enjoy!

0 commit comments

Comments
 (0)