Checklist and Reading Recommendations - The Turing Way

Skip to article frontmatter Skip to article content

Checklist¶

For code auto-formatting¶

Write your development code in your favourite IDE/text-editor.
Enable auto formatting in your editor by tweaking the preferences/settings.
Type Ctrl + s (windows, linux) or ⌘ + s (mac) to save the work to format the code.

For static code analysis¶

Build the project to enable linters to spot the errors/warnings in the code (if any).
Make relevant changes and repeat the above step.
Commit and push the changes to remote Github/GitLab/BitBucket repository to run the pre-deployment tests.

For robust code¶

Find assumptions in your program, and make them explicit.
Write if/else statements to test your assumptions.
Consider errors that may be raised in your program.
Decide per assumption and error what should happen: redirect, report, or abort.
When raising errors, make suree to write informative and actionable messages.

Further reading¶

References specific for this chapter¶

Writing robust code