Enhance philosophy to include supporting documents

- Create instructions for running/compiling the project
- Create any package manager files
This commit is contained in:
Enzo Martin
2023-06-18 10:06:28 +02:00
parent 9c24119f91
commit e29e7bec2f

View File

@@ -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