ImperialCollegeLondon / pyrealm

Development of the pyrealm package, providing an integrated toolbox for modelling plant productivity, growth and demography using Python.

MIT License

16 stars 6 forks source link

Description

This fixes #209:

The CONTRIBUTING.md content is now slimmed down to a quick start and overview.
The development section in the website is now broken out into a more expanded overview (which includes more setup commands and guidance) and then links to individual pages on main development topics.

I've got Read The Docs to build these changes to make it easier to review:

https://pyrealm.readthedocs.io/en/209-development-docs/

Type of change

[x] New feature (non-breaking change which adds functionality)
[ ] Optimization (back-end change that speeds up the code)
[ ] Bug fix (non-breaking change which fixes an issue)

Key checklist

[ ] Make sure you've run the pre-commit checks: $ pre-commit run -a
[ ] All tests pass: $ poetry run pytest

Further checks

[ ] Code is commented, particularly in hard-to-understand areas
[ ] Tests added that prove fix is effective or that feature works

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.23%. Comparing base (aef5907) to head (c66f1a7).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #212 +/- ## ======================================== Coverage 95.23% 95.23% ======================================== Files 28 28 Lines 1701 1701 ======================================== Hits 1620 1620 Misses 81 81 ```