This document is not exhaustive and is not intended to be followed to the letter, these are a series of "rules" that we like to use when reminding ourselves to keep solutions simple and to the point, with that being said let's get started. 🚀
This is heavily inspired by The Zen of Python and The Best Code is No Code At All.
- 📚 Readability is important
- 👌 Be explicit not implicit
- 🛑 Do not write code you don't need
- 🤔 If it feels too complicated it probably is
- 💩 Do not account for features you don't have
- 🚑 Refactor when needed, not if it might be needed later
The essence of the message is this, the less code there is the less chance there is for things to go wrong, developers are inherently forward thinking and want to build the product that can do it all, it's better to do one thing well than many things poorly.