From 4b1e089fba693a04b3abb604db9ae64c67d42089 Mon Sep 17 00:00:00 2001 From: Callum Rollo Date: Tue, 12 Nov 2024 13:49:10 +0100 Subject: [PATCH] Add contributing to readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 134968a..52ae966 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is a repo to diagnose issues in glider data such as CTD thermal lag. This is a work in progress, all contributions welcome! -### Instal +### Install Install from PyPI with @@ -28,3 +28,12 @@ Check out the example notebook `notebooks/demo.ipynb` for example functionality As input, glidertest takes [OceanGliders format files](https://github.com/OceanGlidersCommunity/OG-format-user-manual) +### Contributing + +All contributions are welcome! Please clone the repo and install a local development version of `glidertest` as described in the Install section above. All new functions should include tests, you can run the tests locally and generate a coverage report with: + +```sh +pytest --cov=glidertest --cov-report term-missing tests/ +``` + +Try to ensure that all the lines of your contribution are covered in the tests.