Visualization of the tushare codebase.#1790
Open
ivanmilevtues wants to merge 1 commit intowaditu:masterfrom
Open
Visualization of the tushare codebase.#1790ivanmilevtues wants to merge 1 commit intowaditu:masterfrom
ivanmilevtues wants to merge 1 commit intowaditu:masterfrom
Conversation
Author
|
Hey, just dropping by to announce that our diagram generation engine is now open-source. If you are interested you can check it out here: https://github.com/CodeBoarding/CodeBoarding |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I don’t speak Chinese, so I’ll keep this PR in English to avoid poor translations.
This PR adds diagrams that visualize the tushare codebase:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tushare/on_boarding.md
The goal is to help new contributors understand the architecture quickly. The diagrams are generated using static analysis and LLMs, so there's no ongoing maintenance burden.
Given Backtrader’s 4.3K+ forks, it's clear there’s a strong contributor community. Most contributors focus on specific components, so having a high-level view can really speed up onboarding. We've also added a GitHub Action to keep the diagrams up-to-date automatically.
We’d love your feedback. How do you currently onboard new contributors? If we can help improve that, we’re happy to collaborate.
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.
I would usually start by opening a discussion, but they are not enabled for this repository so I opened a PR instead!