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

Improve README file for the white-whale-std package #254

Open
kerber0x opened this issue Jan 25, 2024 · 0 comments
Open

Improve README file for the white-whale-std package #254

kerber0x opened this issue Jan 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed infra CI infrastructure issue, e.g. Github actions bug

Comments

@kerber0x
Copy link
Contributor

kerber0x commented Jan 25, 2024

If you want to report a security issue, please follow our security policy: https://github.com/White-Whale-Defi-Platform/migaloo-core/blob/main/SECURITY.md


Improvement description

The white-whale-std package has quite an empty readme description, it would be great to improve it, give examples on how the types can be used, mention the feature flags the package owns, what they do etc.


Additional context

Add any other context here, code snippets, json responses, screenshots and so on.

Code sample
Logs
Screenshots
@kerber0x kerber0x added enhancement New feature or request infra CI infrastructure issue, e.g. Github actions bug labels Jan 25, 2024
@kerber0x kerber0x changed the title Fix documentation link on the white-whale-std package Improve README file for the white-whale-std package Jan 25, 2024
@kerber0x kerber0x added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed infra CI infrastructure issue, e.g. Github actions bug
Projects
None yet
Development

No branches or pull requests

1 participant