The-Academic-Observatory / observatory-platform

Observatory Platform Package
https://docs.observatory.academy
Apache License 2.0
18 stars 5 forks source link

Updates to contributing.md and readme #640

Closed keegansmith21 closed 11 months ago

keegansmith21 commented 1 year ago

Changes to some existing docs. These need updating as they're out of date with the current state of the repo. I also make reference the the platform's dependent repositories as they use the same systems.

Notes for post-merge:

keegansmith21 commented 1 year ago

@jdddog Please have a look over the changes and current state of the changed docs. It would be good to get your input - please make any changes you think necessary

codecov[bot] commented 1 year ago

Codecov Report

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

Comparison is base (379ed90) 87.05% compared to head (843dfd0) 87.05%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #640 +/- ## ======================================= Coverage 87.05% 87.05% ======================================= Files 34 34 Lines 4713 4713 Branches 574 574 ======================================= Hits 4103 4103 Misses 483 483 Partials 127 127 ```

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