docs/added new visualization of the codebase for new contributors #7669
+1,585
−0
Conversation
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
|
I'd be happy to review this if you submit a PR to the Hummingbot site https://github.com/hummingbot/hummingbot-site. The diagram is helpful but it would need to be maintained since Hummingbot changes with every release. Also, I would not want to add a dependency in Hummingbot to a new integration just for this diagram. |
|
heyyy thanks for this but we have this type of things on the repo hummingbot site that are our docs. |
|
Thank you for the responses @cardosofede and @fengtality! I can open a PR and will do so in a bit. We are working on the Github Action, it should be ready by the end of the week, so that will solve the problem of you keeping it up-to-date. I will open the PR in the other repo, talk to you there. Thanks again for the responses! |
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.
Before submitting this PR, please make sure:
The first two are not relevent but I checked them.
A description of the changes proposed in the pull request:
This PR contains high-level diagrams for the hummingbot's codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hummingbot/on_boarding.md
Our goal is to help new team members (in this case I suppose it is anyone on github) get up to speed with the codebase more quickly. We believe that having a high-level overview from the start is crucial, and diagrams are one of the most effective ways to convey this. By visualizing the codebase, new contributors can gain context more easily and focus on the specific components relevant to their work - we believe that especially if you are working with good willed contirbutors online they will want to start from a single component (module) of the codebase.
I’d love to hear about your current process for onboarding people to the codebase—do you think these diagrams could be integrated into it?
Any feedback is more than welcome! We've just released a free GitHub Action that can automatically update the diagrams and this way keep them 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.
I would usually start by opening a discussion, but they are not enabled for this repository so I opened a PR instead!
Tests performed by the developer:
Tips for QA testing: