Skip to content

Visualization of the tushare codebase.#1790

Open
ivanmilevtues wants to merge 1 commit intowaditu:masterfrom
CodeBoarding:master
Open

Visualization of the tushare codebase.#1790
ivanmilevtues wants to merge 1 commit intowaditu:masterfrom
CodeBoarding:master

Conversation

@ivanmilevtues
Copy link
Copy Markdown

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!

@ivanmilevtues
Copy link
Copy Markdown
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant