From fc6448aac565ac3aefe3e139185c10e2a0ac72e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Dutrieux?= <loic.dutrieux@gmail.com>
Date: Wed, 10 Jul 2024 12:18:10 +0200
Subject: [PATCH] Some fixes to address improvements suggested during JOSS
 review - Warning note on git lfs added to CONTRIBUTING.md (fixes #14) - List
 of main dependencies added to README (fixes #15) - Document how to run
 unit/integration tests in CONTRIBUTING (fixes #13)

---
 CONTRIBUTING.md | 10 ++++++++++
 README.rst      | 16 ++++++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7910b83..6d053b3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -23,8 +23,18 @@ For any contribution to the code base or the documentation, use the pull request
 2. Apply changes to your fork.
 3. Open a pull request on github
 
+
 Your contribution will be reviewed and discussied as part of the pull request. If approved, it will then be merged
 into the main branch of the repository and included in the following release. 
 
+> :warning: **Ensure that you have git-lfs installed**: The test data included in the package (reasonably sized netCDF and GeoTIFF files) are versioned using Git with the Large File Storage (LFS) extension. Cloning the repository without LFS installed will silently replace these files with placeholders, causing some tests to fail.
+
+### Testing
+
+We use `pytest` for unit tests.
+
+- Unit tests are written using the `pytest` framework.
+- Tests are automatically run using GitHub CI with every push and pull request.
+- You can run tests locally by simply calling `pytest` in the root directory of the project.
 
 
diff --git a/README.rst b/README.rst
index 249301c..9e3a9a7 100644
--- a/README.rst
+++ b/README.rst
@@ -61,6 +61,16 @@ Installation
     pip install nrt
 
 
+The main dependencies, which should be automatically resolved by ``pip``, are:
+
+- `numpy <https://pypi.org/project/numpy/>`_
+- `scipy <https://pypi.org/project/scipy/>`_
+- `xarray <https://pypi.org/project/xarray/>`_
+- `numba <https://pypi.org/project/numba/>`_
+- `rasterio <https://pypi.org/project/rasterio/>`_
+- `netCDF4 <https://pypi.org/project/netCDF4/>`_
+
+
 Example usage
 =============
 
@@ -97,6 +107,12 @@ The snippet below presents a near real time monitoring simulation. The input dat
     # EwmaMonitor.to_netcdf(filename)
 
 
+Contributing
+============
+
+Any type of contribution is welcome. Please see the contributing guidelines at `CONTRIBUTING.md <CONTRIBUTING.md>`_.
+
+
 About the authors
 =================