Saw your apps-android-commons repo in #help_wanted
codeca...@gmail.com
Hi Commons,
Saw your repository apps-android-commons on the #help-wanted Github page! My friend and I are building a tool that will not only invite helpers in, but get them contributing at a pace that will have you quickly planning for what to build next.
We have struggled with understanding large codebases and taking too long to onboard before we can make a contribution, and I'm pretty sure you as a repo maintainer spend a long time on back and forth PR comments and explaining how the project works for contributors. We are trying to solve the problem of understanding a complex codebase quickly, so we built CodeCanvas (code-canvas.com): A free codebase visualization and documentation tool.
Through CodeCanvas we can build an architecture diagram of apps-android-commons repository and link the diagram elements to its corresponding source code, then record tutorials on the diagram like the flow of data and business logic (we call them simulations). I believe it could be a useful tool for apps-android-commons, especially for those new contributors to the codebase. I think it would help cut onboarding time and reduce the number of PR revisions.- Here's a quick overview of Code Canvas. Also, check out this demo to get a feel for the platform:
- Go to the simulations tab, select a simulation and hit the play button
- Select the simulation "Tutorial: e-commerce site architecture" for the tutorials type of simulations
- Select the simulation: "Checkout process" for the data flow type of simulations
Again, CodeCanvas is free for early adopters, and since we chose your repository as one of the few to reach out to, we are willing to actually help with building the diagram of apps-android-commons for you.
Next steps
you can either:
- (Recommended) Schedule an onboarding call with me to give me a quick overview about apps-android-commons's codebase architecture and I'll build your diagram (free of charge!): https://calendar.app.google/yxs33AsZwBQaUmv5A Or
- Start building the diagram on your own referencing our documentation and let me know if you have questions either by replying to this email and joining our discord server.
Looking forward to hearing from you!
Best,
Nasser