Skip to content

Commit

Permalink
Add contributing to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
callumrollo authored Nov 12, 2024
1 parent 89883d8 commit 4b1e089
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

0 comments on commit 4b1e089

Please sign in to comment.