Frequently Asked Questions

What do the different priority colors mean?

Priority is ranked by XRank: higher priority classes give the most benefit per unit of refactoring effort. Colors range from red (highest priority) to green.

How often should I run RefactorFirst?

On every merge to your default branch. The provided GitHub Actions workflow does this automatically.

What if my repository doesn't have a report?

Generate one with mvn refactorfirst:jsonReport and commit the.refactorfirst/refactor-first.json file. SeeGetting Started.

How do I add my repository to the listing?

Use the Add Your Repo page. It opens a pre-filled issue on this site's platform (GitHub, GitLab or Bitbucket); submitting that issue is all you need to do. You must have write access to the repository.

How long until my repository appears after submission?

The CI validation picks issues up shortly after they are created (the GitHub deployment reacts immediately; GitLab and Bitbucket deployments poll on a schedule), and the site redeploys on a 10-minute schedule — so in the worst case about 20 minutes.

Why is there no sign-in on this site?

Your identity is captured by your platform when you create the submission issue: the issue author is a verified account, and the CI job independently confirms that account has write access to the submitted repository. That proves ownership without any tokens or apps.

Is my platform data safe?

Yes. This site never receives credentials, tokens or permissions from you. The validation runs entirely in this project's own CI.

What are disharmonies like God Class and Brain Method?

Disharmonies are design flaws detected from metrics: a God Class does too much, a Brain Method is an overly complex method, Feature Envymeans a method relies on another class's data more than its own.

Can I compare branches?

You can view the report on any branch via the URL/<user>/<repo>/<branch>, but side-by-side comparison is not currently supported.