-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Update docs and add template files #57
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #57 +/- ##
=======================================
Coverage 96.32% 96.32%
=======================================
Files 12 12
Lines 571 571
=======================================
Hits 550 550
Misses 21 21 ☔ View full report in Codecov by Sentry. |
Will be taken out of draft once #58 is merged |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks great, the format works well and is easy to read, just had the one small comment about one of the links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some nit picks around readability
Otherwise really good improvement and explanation of the repo
Updated the README.md.
Added documentation about the config.yaml file. This does not yet exist but is a proposed idea. Once I have made the functional changes (changing read methods and tests) then I will put this PR forward for merging.