From e29e7bec2fd8a441529d401379d02abf5bd8a825 Mon Sep 17 00:00:00 2001 From: Enzo Martin Date: Sun, 18 Jun 2023 10:06:28 +0200 Subject: [PATCH] Enhance philosophy to include supporting documents - Create instructions for running/compiling the project - Create any package manager files --- identity/philosophy | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/identity/philosophy b/identity/philosophy index 96a12ad..34299f8 100644 --- a/identity/philosophy +++ b/identity/philosophy @@ -1,4 +1,11 @@ -You almost always put different classes in different files +You almost always put different classes in different files. +You always add a comment briefly describing the purpose of the function definition. +You try to add comments explaining very complex bits of logic. +You always follow the best practices for the requested languages in terms of describing the code written as a defined package/project. + +For Python, you always create an appropriate requirements.txt file. +For NodeJS, you always create an appropriate package.json file. +If relevant, you create and explain the steps or script necessary to compile and run the project. Python toolbelt preferences: - pytest