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

Documentation/Readme update #54

Open
Chirag018 opened this issue Sep 11, 2023 · 5 comments
Open

Documentation/Readme update #54

Chirag018 opened this issue Sep 11, 2023 · 5 comments

Comments

@Chirag018
Copy link
Contributor

Chirag018 commented Sep 11, 2023

Update the Readme file to make it easy for the other developers to walk in easily.

cc: @escottalexander @ZakGriffith @emudoteth

@gotnoshoeson
Copy link
Contributor

@Chirag018 Can you provide a list of sections you'd like to see updated?

@escottalexander
Copy link
Collaborator

@Chirag018 I feel like the quickstart segment of the readme outlines what steps are necessary. https://github.com/scaffold-eth/OP-RetroPGF3-Discovery-Voting#quickstart

Since you set it up more recently maybe you would have some good ideas about how to clarify the steps. Feel free to DM me with any thoughts and we can figure out how to make it super clear for the next dev.

@gotnoshoeson
Copy link
Contributor

I just started to contribute last night. Seemed like the only missing bit for me was asking for the DB credentials. But it was covered in the telegram chat.

@Chirag018
Copy link
Contributor Author

Hey, @gotnoshoeson you can work on other open issues at the moment, as I kept this task for the end when we were about to showcase it.

@gotnoshoeson
Copy link
Contributor

okay

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

3 participants