Diagram visualization for the labelme codebase #1598
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
I have generated high-level diagrams for the labelme project. The idea is to help people get up-to-speed with the codebase (as contributors), you can check it here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/labelme/on_boarding.md
The diagrams show the main components of the codebase, allowing people who want to change somethin in it to quickly identify where they want to go to. Then with the context in their head, they can change the component of interest knowing how it interacts with the rest of the codebase. In the case of labelme, which has more than 3.5K forks, I think this can be valuable resource for the people who play with the codebase. Let me know what is your take on the said above!
If you like the diagrams I'd be more than happy to open a PR :)
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.
Beta Was this translation helpful? Give feedback.
All reactions