Navigating the Maze #4385
notbonzo-com
started this conversation in
General
Replies: 1 comment
-
+1, I'd be happy to add some docs too (maybe Doxygen too given the size of the project?). |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hey Daniel,
I really appreciate you for maintaining an open source project like this from the good of your heart and I understand everyone has their own preferred coding style, but this has to be, no joke the most horrid one you could come up with. The fact that everything is a header included by one translation unit would be fine, if you didn't depend on symbols "falling through" from the includes above, which fucks up any LSP trying to help a poor soul read this mess. I see you are vivid on making a lot of files and classes and templates, and while being modular is good, do we really need a templated inherited object of a toggle-able feature which takes a templated feature context, templated by another context (I am already lost) which itself in some instances even is templated by a feature context state which is then also passed as a template parameter of the core context and the code pulls it from god-knows-where on the other end of the project.
That being said, I genuinely appreciate the effort you’ve put into this project, I understand that maybe you like this and/or it is because of performance reasons, However, I believe that introducing some clear documentation or a contribution guide to explain the interactions and design philosophy could go a long way in helping others understand and work with the codebase. Something to help people get a hang of 640 headers (Holy that's insane).
If you’d be open to it, I’d be happy to collaborate on starting to make a simple contribution guide and some way points around the project to make it more accessible to newcomers (or even just making a simple guide on how to add a simple new feature). This way, your build system can remain the same while allowing others to read it.
Beta Was this translation helpful? Give feedback.
All reactions