ImperialCollegeLondon / virtual_ecosystem

This repository is the home for the codebase for the Virtual Ecosystem project.
https://virtual-ecosystem.readthedocs.io
BSD 3-Clause "New" or "Revised" License
9 stars 1 forks source link

Update contributor docs #499

Closed davidorme closed 2 months ago

davidorme commented 3 months ago

Description

This PR is to update the contributor/developer docs to make them up to date and fit for an external audience.

Todo:

Fixes #498

Type of change

Key checklist

Further checks

davidorme commented 3 months ago

@vgro I've moved the files in. Now we need to review and adapt.

codecov-commenter commented 3 months ago

Codecov Report

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

Project coverage is 94.91%. Comparing base (63fceb6) to head (a0bceb2).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #499 +/- ## ======================================== Coverage 94.91% 94.91% ======================================== Files 70 70 Lines 3857 3857 ======================================== Hits 3661 3661 Misses 196 196 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

vgro commented 3 months ago

I changed all the references from pyrealm to virtual_ecosystem and highlighted a few issues where I wasn't sure if that was still up to date.

davidorme commented 2 months ago

@TaranRallings and @jacobcook1995

Vivienne and I have been over this and updated for VE - can you have a look over the Development section updates. I've built the branch:

https://virtual-ecosystem.readthedocs.io/en/498-update-contributor-documentation/

Ignore the "The design of the Virtual Ecosystem" section. That still needs work.