Skip to content

Instantly share code, notes, and snippets.

@xNWDD

xNWDD/Good Code 101

Created February 12, 2017 13:31
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save xNWDD/f02197abd58dc0a28c10109de4439d0a to your computer and use it in GitHub Desktop.
Save xNWDD/f02197abd58dc0a28c10109de4439d0a to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Good Code 101
0.- Don't build everything at once, build something that works, then iterate, distribute and refactor.
1.- Write clean, self-explaining, predictable code, add comments if it's not.
2.- Follow the principle of least knowledge, consider state, platform & compiler specific code alien units.
3.- Use the right tool for the right job investigating languages, platforms, targets, compilers and debuggers.
4.- Don't reinvent, overinvent or keep unused inventions around (YAGNI/KISS).
5.- Write consistent code, following the project coding guidelines (identation, spacing, naming)
6.- Make units and functions do always the same ONE predictable thing in a predictable, ordered way.
7.- Don't optimize something that isn't a bottleneck.
8.- Avoid designing code so that it has to guard for specific cases.
9.- If test cases are trivial to implement, implement them.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment