Skip to content

Conversation

@ivanmilevtues
Copy link

You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/face_recognition/on_boarding.md

The PR contains diagrams designed to help new contributors get up-to-speed with the codebase! Considerting you have the instance number of more than 13K forks, you have lots of people interacting with the codebase as contributors. We believe most of them are interested in a concrete module/component which they want to improve/customize. This said we think the diagrams are the best form of "onboarding" as they give overview of the full codebase and the new person can identify which component is of interest, then they can go deeper into it. Now they can see which source code is related to the component and have the context of how it interacts with the rest of the codebase. Let me know what is your opinion on the matter!

We’ve also released a free GitHub Action that keeps the diagrams automatically updated as the code changes, so there's no ongoing maintenance burden.

Any feedback is more than welcome, I'd love to hear if there is something else I can help with!

I'd usually open a discussion first, but you don't have them enabled for this repo so I decided to go ahead and open a PR.

Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.

@ivanmilevtues
Copy link
Author

An update on our side, our generation engine is now open source: https://github.com/CodeBoarding/CodeBoarding
You can find there more details on how the whole generation works!

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