Skip to content
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

Add more details to the dev docs and update README #68

Merged
merged 3 commits into from
Jan 31, 2023

Conversation

taylorreiter
Copy link
Member

@taylorreiter taylorreiter commented Jan 27, 2023

This PR updates the developer documentation and the README. I think it's the last PR (🤞) before linking to zenodo, cutting the first release (v. 0.1.0 🎉) and getting a DOI, so please mention anything else that sticks out that you think needs to be done before hand!

*Note the DOI and link to the pub won't resolve until the pub is released, but I want them to be recorded in zenodo so I'm using them as placeholders as they are accurate.

@taylorreiter taylorreiter marked this pull request as draft January 27, 2023 15:15
@taylorreiter taylorreiter changed the title Add more details to the dev docs Add more details to the dev docs and update README Jan 30, 2023
@codecov-commenter
Copy link

Codecov Report

Base: 92.02% // Head: 92.02% // No change to project coverage 👍

Coverage data is based on head (204eda3) compared to base (3cf1ade).
Patch has no changes to coverable lines.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage   92.02%   92.02%           
=======================================
  Files           8        8           
  Lines         627      627           
=======================================
  Hits          577      577           
  Misses         50       50           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@taylorreiter taylorreiter marked this pull request as ready for review January 30, 2023 20:10
Copy link
Member

@elizabethmcd elizabethmcd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻 lgtm - I think good to go for final PR for cutting a release and getting ready for pub

@taylorreiter taylorreiter merged commit 9ceaa18 into main Jan 31, 2023
@taylorreiter taylorreiter deleted the ter/update-docs branch January 31, 2023 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants