8000 Ensure each package's README lists purpose and accurate usage examples · Issue #5742 · MetaMask/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Ensure each package's README lists purpose and accurate usage examples #5742

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.

Sign up for GitHub

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

Jump to bottom
Open
mcmire opened this issue May 1, 2025 · 1 comment
Open

Ensure each package's README lists purpose and accurate usage examples #5742

mcmire opened this issue May 1, 2025 · 1 comment
Labels
team-wallet-framework

Comments

@mcmire
Copy link
Contributor
mcmire commented May 1, 2025 •
edited
Loading

Most of the packages in the core repo have a very spartan README. While this makes it easy to maintain, it is not very helpful for contributors.

Ideally, each package's README should describe its purpose and provide usage examples.

As a bonus, we should consider finding a way to make the usage examples executable, and run them in CI (similar to Rust's documentation tests).
@lukasbauer54 lukasbauer54 mentioned this issue May 21, 2025
Open
4 tasks
@lukasbauer54
Copy link

Hi @mcmire , I’ve opened a PR for this. I’d really appreciate it if you could take a look when you get a chance. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
team-wallet-framework
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mcmire @lukasbauer54
0