General

  • Campsite Rule

    • Always leave the codebase better than you found it.

  • Code Over Comments

    • Comments should be used to add description where it cannot be added in code.

  • Keep It Simple, Silly

    • The KISS principle is the idea that you should try to keep things as simple as possible, but not simpler.

  • Log Only What's Needed

    • Ensure that anything the application logs is either at the right log level or has a useful purpose.

  • Non-Defensive

    • While being defensive for error scenarios can be a good practice, doing it by default without understanding the scenarios that could create an error tends to lead to lots of unneeded code.

  • Robustness Principle

    • Be conservative in what you send, be liberal in what you accept.

  • YAGNI - You Ain't Gonna Need It

    • Do the simplest thing that could possibly work.