glato / emerge

Emerge is a browser-based interactive codebase and dependency visualization tool for many different programming languages. It supports some basic code quality and graph metrics and provides a simple and intuitive way to explore and analyze a codebase by using graph structures.
MIT License
783 stars 46 forks source link

Opinionated examples of "good" graphs and "bad" graphs #17

Closed johannes-graeter closed 2 years ago

johannes-graeter commented 2 years ago

Is your feature request related to a problem? Please describe. I just created the first graph of one of the projects I work in. It looks AMAZING!!! First seeing this graph however it is kind of hard to draw concrete conclusions from it. It would be awesome to have some opinionated examples (f.e. I could imagine nicely seperated clusters like in the firework-like graphs in the README point to good interfaces and well made modules whereas tightly entangled ones smell like a need for interface-lift...) in order to speed up the process of learning to interpret those.

Describe the solution you'd like Would be cool to have some more examples as in the readme that do not only show how it looks like but point to possible interpretations.

glato commented 2 years ago

@johannes-graeter Thanks a lot for the feedback 👍. It sounds like a useful addition to the README to add further examples and explain some indicators (that e.g. might reveal an increased modularity or in the opposite an increased necessity to create interfaces/abstractions), which could help derive insights more easily or intuitively. I'll see what I can do about that in the following days 🤔.

johannes-graeter commented 2 years ago

Awesome glato, thanks for your great project and your dedication!

glato commented 2 years ago

@johannes-graeter I've included some examples with descriptions in the README. I would appreciate any feedback on whether such examples help with the interpretation or contribute to a better understanding.

johannes-graeter commented 2 years ago

@glato This is awesome work, thanks exactly what I had in mind! Already helped me a lot (especially the hint to ignre dependencies)