If you have a local clone of the repository that **predates Feb. 19th, 2025, you must absolutely make a new clone**.
...
...
@@ -426,6 +427,7 @@ When creating a new modules, class, method or function, add a [docstring](https:
[PEP257](https://peps.python.org/pep-0257/) documents the conventions related to Python docstrings. This is especially important because in the near future, the documentation of the framework will be automatically generated with Sphinx, a tool that parses docstrings to generate the building blocks of a static website.
## git
-**NEVER** add "all files" to git's tracked files (i.e. DO NOT use `git add .` or `git add -A` or `git add -A .`).
It can create confusion when going back to a previous commit and hide meaningful changes in a heap of modified or newly created files
-**NEVER** add "all files" to git's tracked files (i.e. DO NOT use `git add .` or `git add -A` or `git add -A .`), for 2 reasons :
- either it adds many modified or newly created files, making it hard to distinguish meaningful changes in a commit
- either it will miss files intended to be tracked just because their extension is listed in .gitignore (e.g. if you create a new csv file that is required to run a simulation, `git add .` and similar commands will miss it)
- regularly pull `main` and `develop` branches from remote so you have the latest changes on your computer
