python-fire
python-fire copied to clipboard
Visualziations of the python-fire codebase
This PR contains high-level diagrams for the python-fire codebase. You can see how they render in Github here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-fire/on_boarding.md
These diagrams help users quickly grasp the codebase. Google is a huge organization so I would love to hear what is your current on-boarding process, when it comes to working with new codebases. Do you think that such diagrams can have place in it? We are generating the with static analysis and LLMs, so they are based on the code itself without external resources.
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.
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).
View this failed invocation of the CLA check for more information.
For the most up to date status, view the checks section at the bottom of the pull request.
Thanks for offering, but I don't plan on incorporating these diagrams at this time.
Hey @dbieber, just dropping by to let you know that now we are open source: https://github.com/CodeBoarding/CodeBoarding So if you are interested you can take a look at the codebase :)