Design Philosophy
Style Guides are nothing new, and despite there being a never ending amount of them - each with their own group advocating for it to be the universal standard - there is simply no objective way to style your code; regardless of how objective we feel our personal tastes are.
The guidelines you will see in this Style Guide come from a 10 year process of developing and curating my own personal coding style. Every design decision comes with a hardened intention formed through realized pain points and an effort to overcome them.
Every design decision is made to facilitate healthy, maintainable, and cooperative codebases. The overall goal is:
- To produce code that is self-documenting and accessible.
- To produce code explicit in behavior so that no room is left for interpretation or misunderstanding.
- To produce code that isn't too verbose to the point of needlessness but also to not produce code that is so compact that it is indecipherable and cannot be understood at a glance.
- To produce code where the scope and write context can be understood without a reliance on Intellisense or a deeper understanding of the codebase.
- and To produce code that minimizes eye strain and maximizes reading speed.
This Style Guide will be forever evolving in an effort to always find better solutions to satisfy these goals. There is no expectation for you to fully adapt what is presented in the Guide, just simply consider it.