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

Cleanup / Improve readme #161

Open
archae0pteryx opened this issue Mar 8, 2022 · 0 comments
Open

Cleanup / Improve readme #161

archae0pteryx opened this issue Mar 8, 2022 · 0 comments

Comments

@archae0pteryx
Copy link
Collaborator

The readme could be improved as some of the steps outlines are not necessary or don't reflect current flow.

  • Openzepplin is already a dependency (should be a dev dependency) and doesn't need to be installed again.
  • Docs about verifying a contract are a bit vague. There are several contracts. Which are we verifying? What other contracts exist? How do we test them?
  • The instructions for local dev are missing steps, local requirements (node version) and other tooling specific information.
  • There is no info for contribution guidelines or the expectations around review. There are some good templates for contribution that we can use and tweak for our needs
  • General gussying up. Maybe add coverage badges and / or contribution counts (ice box idea)
@archae0pteryx archae0pteryx changed the title Cleanup readme Cleanup / Improve readme Mar 8, 2022
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

No branches or pull requests

1 participant