nannou
nannou copied to clipboard
nannou-org
Developer reference?
Just checking to see if there's any progress regarding this. I'm trying to contribute to this project but I'm having a hard time understanding the codebase, and trying to figure out where to start.
I've created some diagrams (c4 based), which i will share later for review, trying to contribute what i can.
concerning the crate structure...
-edit: I think that focussing on the nannou crate (shown on the left) and the sub-dependencies would be best to start with.
-edit: I think that focussing on the nannou crate (shown on the left) and the sub-dependencies would be best to start with.
Thanks, this is very helpful. Let me know when you share the diagrams.
Thank you @nate-sys , i had a few hours today to try and fabricate something.
Let me know what you guys think (also @mitchmindtree @JoshuaBatty), it's a starting point: https://github.com/mvklingeren/nannou/blob/task/diagrams/guide/src/developer_reference.md
Howdy! Those diagrams do look nice, @mvklingeren. I wonder how we could adapt them to the background color of the docs however, seeing as there are five different themes and with dark themes especially it becomes very hard to read.
Anyway I'd love to hop in and contribute as I'd hit a similar roadblock as OP when first checking out the docs. Have you gotten any material done to complement the diagrams, @nate-sys ?
I'll wager we could possibly have, as a first stepping stone:
- How to navigate the reference (from the dev reference TO-DO)
- The kinds of work that should go inside the main repo, the kinds that might be better off in separate repos (also from the TO-DO)
- Branch name examples for contributing merge requests (minor)
Cheers
@nidnogg I've been away from nannou recently so I haven't made any progress, sadly. I'll try and look into it.
In the mean time, I feel as though the owners should at least some general direction on how contributors should approach this project.