MaibornWolff / codecharta

CodeCharta is a visualization tool that transforms complex software architecture and code metrics into interactive, customizable visual maps, empowering everyone to communicate and analyze your codebase. Improve code quality, maintainability, and architectural decisions
https://maibornwolff.github.io/codecharta/
BSD 3-Clause "New" or "Revised" License
196 stars 31 forks source link

No suspicious metrics in the CodeCharta code base #2415

Open BridgeAR opened 3 years ago

BridgeAR commented 3 years ago

Feature request

Description

As a CodeCharta developer, I want all buildings to have a low complexity and low suspicious metrics so that the code base is understandable and nothing obvious suspicious is visible in our own codebase.

Acceptance criteria

Development notes (optional Task Breakdown)

Please split the work into multiple chunks that are easy to review.

BridgeAR commented 3 years ago

This story is meant as an epic and all code that we touch should improve situations in case where the files have non green metrics.

IhsenBouallegue commented 2 years ago

I don't feel like this issue should be part of the Good First Issue Milestone. Refactoring takes time and one should understand the code base well to begin with. It is also dependent on the experience of the individual. It will be frustrating for some if they jump right into this.

In my opinion, we should leave this one out of the milestone and also decide on concrete steps to improve the metrics. For example, identify which files cause the problem for a certain metric and what we can do about it. (Basically audit CodeCharta and that would be better done with the help of someone who has done audits before)

BridgeAR commented 2 years ago

@IhsenBouallegue thanks for the input. I removed it from the milestone.