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

docs(epoch-manager): add readme to epoch manager #353

Merged
merged 2 commits into from
May 21, 2024

Conversation

kerber0x
Copy link
Contributor

Description and Motivation

This PR adds a readme file explaining how the epoch manager works.

Related Issues


Checklist:

  • I have read Migaloo's contribution guidelines.
  • My pull request has a sound title and description (not something vague like Update index.md)
  • All existing and new tests are passing.
  • I updated/added relevant documentation.
  • The code is formatted properly cargo fmt --all --.
  • Clippy doesn't report any issues cargo clippy -- -D warnings.
  • I have regenerated the schemas if needed cargo schema.

@kerber0x kerber0x marked this pull request as ready for review May 20, 2024 14:30
Copy link

codecov bot commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.15%. Comparing base (0f77427) to head (1d6ffbc).
Report is 32 commits behind head on release/v2_contracts.

Additional details and impacted files
@@                   Coverage Diff                    @@
##           release/v2_contracts     #353      +/-   ##
========================================================
+ Coverage                 90.09%   91.15%   +1.06%     
========================================================
  Files                       278      279       +1     
  Lines                     29604    31119    +1515     
========================================================
+ Hits                      26673    28368    +1695     
+ Misses                     2931     2751     -180     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@0xFable 0xFable left a comment

Choose a reason for hiding this comment

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

LGTM good work, I'd love to see some more here about how we are using the epoch manager at a high level i.e the clock and how that affects other contracts

@kerber0x
Copy link
Contributor Author

LGTM good work, I'd love to see some more here about how we are using the epoch manager at a high level i.e the clock and how that affects other contracts

Cool, will add that.

@kerber0x kerber0x merged commit 5419588 into release/v2_contracts May 21, 2024
7 checks passed
@kerber0x kerber0x deleted the docs/epoch-manager-readme branch May 21, 2024 11:29
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.

2 participants