Guides for getting things done, programming well, and programming in style. These are based on my observations, learnings, participation in best practices and borrowing of good ideas. Feel free to adopt these guides if you find them useful.
High level guidelines (when you are following a guide):
- Be consistent.
- Don't rewrite existing code to follow this guide.
- Don't violate or make an exception to the guideline without a good reason.
- A reason is good when you can convince a teammate.
A note on the language:
- Code reviews can sound passive agressive, so try to be polite but make assertive statements.
- "Avoid" means don't do it unless you have good reason.
- "Don't" means there's never a good reason.
- "Prefer" indicates a better option and its alternative to watch out for.
- "Use" is a positive instruction.