Resonate icon indicating copy to clipboard operation
Resonate copied to clipboard

Update Onboarding and Readme for local setup for new contributors

Open uju09 opened this issue 1 month ago • 9 comments

šŸš€ The feature

We should update the Onboarding and readme for new contributors.

Motivation, pitch

Many new contributors are facing the issue for setting up local environment for contribution.

uju09 avatar Nov 08 '25 20:11 uju09

šŸ‘‹ Hello @uju09!
Thank you for opening this issue. Our team will review it soon. šŸš€

  • If you can, please provide more details like steps to reproduce, expected vs. actual behavior, and screenshots (if applicable). šŸ“Œ

We appreciate your contribution! šŸ’”

github-actions[bot] avatar Nov 08 '25 20:11 github-actions[bot]

@M4dhav Many new contributors are facing issue of setting Resonate locally. I think we should automate it. If you think we need this, then please assign it to me.

uju09 avatar Nov 08 '25 20:11 uju09

Resonate Setup is failing on a case to case basis with different reasons. An automated setup script for the backend already exists, so what would the differences be in this one?

M4dhav avatar Nov 09 '25 19:11 M4dhav

@M4dhav For frontend.

uju09 avatar Nov 09 '25 19:11 uju09

In my opinion a script would be unnecessary, as the user only has to run flutter pub get and then flutter run to compile the frontend. However, since new users are having issues setting up the project, it might be a good idea to update the ONBOARDING and Readme documentations to clearly specify Java and Flutter versions Resonate is known to be working with

M4dhav avatar Nov 09 '25 19:11 M4dhav

Ok if this is the issue and let's fix it. Should I start work on it?

uju09 avatar Nov 09 '25 19:11 uju09

Yeah, edit this issue and I'll assign it to you

M4dhav avatar Nov 09 '25 19:11 M4dhav

@M4dhav I edited the issue. i request you to assign it to me.

uju09 avatar Nov 10 '25 11:11 uju09

Hi, I would like to work on this issue. I see this involves updating the README / onboarding instructions for new contributors. I am comfortable with GitHub contributions, and I’d like to take this up. Please assign this issue to me. Thank you!

npniranjan539-arch avatar Nov 12 '25 16:11 npniranjan539-arch