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(incentive-manager): add readme to incentive manager #354

Merged
merged 3 commits into from
May 21, 2024

Conversation

kerber0x
Copy link
Contributor

Description and Motivation

This PR adds information about how the incentive manager works on a high level on a readme file.

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.

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 (61ed894) to head (04a91a8).
Report is 1 commits behind head on release/v2_contracts.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           release/v2_contracts     #354   +/-   ##
=====================================================
  Coverage                 91.15%   91.15%           
=====================================================
  Files                       279      279           
  Lines                     31119    31119           
=====================================================
  Hits                      28368    28368           
  Misses                     2751     2751           

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

@kerber0x kerber0x force-pushed the docs/incentive-manager-readme branch from 0c3ac63 to bf214b2 Compare May 20, 2024 16:17
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.

Great work on this! 🚀 Left some suggestions on how to improve the flow and stuff
Make it as verbose as you can I'd say and at the end I will show you how to generate a markdown table of contents to make it easy to navigate even if its massive

contracts/liquidity_hub/incentive-manager/README.md Outdated Show resolved Hide resolved
contracts/liquidity_hub/incentive-manager/README.md Outdated Show resolved Hide resolved
contracts/liquidity_hub/incentive-manager/README.md Outdated Show resolved Hide resolved
contracts/liquidity_hub/incentive-manager/README.md Outdated Show resolved Hide resolved
@kerber0x kerber0x requested a review from 0xFable May 21, 2024 10:41
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 great job!! 🚀

@kerber0x kerber0x merged commit 79d0294 into release/v2_contracts May 21, 2024
7 checks passed
@kerber0x kerber0x deleted the docs/incentive-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