Add code comments to aid contributor onboarding
Opened this issue · 1 comments
I'm opening this issue as more of a reminder than a one-time task.
It took me > 6 months to get familiar with the code base and I'm still weak in areas. Now this may say more about me than it does about the project, but I suspect the latter.
Adding header comments outlining the purpose of a file/class and how it's used by its dependents could go a long way toward easing onboarding for new contributors. Describing how the pieces fit into the overall algorithm would also be really useful. Adding links to portions of or copying pieces of your dissertation could help too @disnet.
Good idea! The codebase is definitely complex. I'd be holding off doing too much design documentation for a while since pieces were still in flux but I think most things are stable enough for this to be worth it now.