-
Notifications
You must be signed in to change notification settings - Fork 2
Code
jmshapir edited this page Jul 26, 2016
·
3 revisions
- Each bottom-level folder has exactly one make script that executes all code in the entire folder.
- All code outputs a log that at a minimum shows date/time and ideally includes some informative logging messages showing what operations were performed.
- Code used across multiple bottom-level folders is abstracted to a library in /lib and unit tests are written.
- Code is designed to be clear and self-documenting whenever possible.
- The name of an object makes its purpose clear.
- Comments and documentation should be used only when this approach does not make code sufficiently clear.
- More abstract code (e.g. a library used across multiple projects) should get better documentation