Skip to content

Instantly share code, notes, and snippets.

View beothorn's full-sized avatar
:octocat:

Beothorn beothorn

:octocat:
View GitHub Profile
These are the main guidelines:
Break responsibilities in different functions and files.Use folders to separate code by domains. Organize it in a way anyone can find the code related to a functionality looking at the folder structure. Add a comment in the header to make clear what is the file responsoble for. Use clear variable names. Write as little code as possible, simple is better. Before every function always add a human readable comment should describe the function, even if it is redundant. Anyone should be able to recreate the function from the comment.
The task description:
....