codecharta icon indicating copy to clipboard operation
codecharta copied to clipboard

Fix/3456/update mcc naming

Open Nereboss opened this issue 9 months ago • 6 comments

Update MCC naming

Closes: #3456

Description

Temporarily adds 'formerly mcc' to the no longer renamed sonar complexity

Definition of Done

A PR is only ready for merge once all the following acceptance criteria are fulfilled:

  • [ ] Changes have been manually tested
  • [x] All TODOs related to this PR have been closed
  • [x] There are automated tests for newly written code and bug fixes
  • [x] All bugs discovered while working on this PR have been submitted as issues (if not already an open issue)
  • [x] Documentation (GH-pages, analysis/visualization READMEs, parser READMEs, --help, etc.) has been updated (almost always necessary except for bug fixes)
  • [x] CHANGELOG.md has been updated

Screenshots or gifs

Nereboss avatar Apr 30 '24 10:04 Nereboss

We need to investigate how this change will impact our online demo.

phanlezz avatar May 02 '24 09:05 phanlezz

I rebased the branch to include the main changes

phanlezz avatar May 06 '24 08:05 phanlezz

I did some testing and here are some points that I found. We should evaluate if those changes are acceptable:

  • the current metric of the web demo can't be found, uses sonar_cognitive_complexity in local testing -> adjust link
  • "Metric Templates" are not applicable anymore (contain mcc)
  • "Suspicious Metrics" - MCC does not get detected as a preset
  • Attribute Descriptor Title for the sonar import still state "Maximum ...". We should change that.

phanlezz avatar May 06 '24 09:05 phanlezz

I think all these points should be addressed before merging this issue.

i further found that we include other metrics that talk about mcc (the sourceMonitor has max_function_mcc and average_function_mcc) that should be changed as well here.

Nereboss avatar May 07 '24 13:05 Nereboss

All the previously found issues should be resolved. Additionally, the metrics "complexity" and "sonar_complexity" will include (formerly mcc) in their display name in the search (and are also findable my searching for mcc).

Nereboss avatar Jun 11 '24 12:06 Nereboss