Minor (add notes on .gitignore)

Author: ltatzel

.gitignore

@@ -1,3 +1,9 @@
+# Ignore everything in results by default
+results/*
+
+# But track these subfolders
+!results/01_first_experiment/
+
 # VS Code
 .vscode/
 

README.md

@@ -31,11 +31,10 @@ extended (for example with automated formatting).
 - **Continuous Integration:** Whenever code changes are made, it is useful to
   automatically check whether everything still works. This process is called
   *Continuous Integration (CI)*. This template includes a GitHub workflow in
-  `.github/workflows` that automatically creates a virtual environment,
-  installs the project dependencies and runs the tests using `pytest`. If
-  something fails, the workflow reports the error. CI also ensures that all
-  required dependencies are explicitly listed, which is important for
-  reproducibility.
+  `.github/workflows` that automatically creates a fresh environment, installs
+  the project dependencies and runs the tests using `pytest`. If something
+  fails, the workflow reports the error. CI also ensures that all required
+  dependencies are explicitly listed, which is important for reproducibility.
 
 - **Clean Code:** Of course, writing clean and readable code is always
   beneficial. Some useful principles include:
@@ -60,7 +59,7 @@ The repo is organized into four main folders.
   tests. These files live in `source/our_library`. This folder can be installed
   as a local Python package via `pip install -e .`. This is nice because after
   installation, functions can be imported in experiments like this `from
-  research_lib.some_functions import add_10`. 
+  our_library.some_functions import add_10`. 
 
   The `source` folder also contains a `tests` directory for automated testing.
   A useful convention is to mirror the structure of the library and the tests. 
@@ -75,8 +74,11 @@ The repo is organized into four main folders.
 
 - **`results`:** The `results` folder stores outputs generated by experiments.
   Its structure mirrors the `experiments` folder. Typical outputs include
-  plots, tables, trained models or intermediate data. Larger files can either
-  be excluded from git with a `.gitignore` file or tracked with Git LFS.
+  plots, tables, trained models or intermediate data. As results can be large,
+  we exclude the content of the `results` folder from git tracking by default.
+  However, if your files are small, you can tell git explicitly to track the
+  subfolder via `!results/01_first_experiment/` in the `.gitignore` file. An
+  alternative for large files is to use Git LFS.
 
 - **`documentation`:** The `documentation` folder contains project
   documentation. Currently it includes a minimal LaTeX paper template in
@@ -132,4 +134,4 @@ Some tasks to get you started:
    in the paper.
 8. **Adapt and Extend:** Adapt and extend the template as needed for your own
    research project. For instance, you might want to rename the virtual
-   environment and the `our_library` folder.
+   environment and the `our_library` folder.