EE-IP3-BH01

Coding guidelines

1. Every function should document what the inputs and outputs are using comments
2. Function and variable names should follow the snake_case format
3. Keep the architecture horizontal: Try to avoid nested functions, keep them parralel.
4. Write (multiple) tests for a function
5. One function should do one job. If a function does multiple things, split the function into mulitple functions.
6. Try to keep functions short (max x lines)
7. A maximum indentation of x is preffered
8. Document desiscions made
9. A feature should first be made in a branch. Later can be merged into main
10. AI can be used as a search engine. Not a replacement.
11. Every file path should use the python Path function from pathlib

Report guidelins

1. Every table, figure and equation needs a label.
2. Label should be of ":-"
3. Check grammer
4. AI can be used as for short phrases

Human guidelines

1. Short meetings at start of lab.
2. Be on time for a lab
3. If you cannot be on time, let it know.
4. Keep each other up to date.