-
Notifications
You must be signed in to change notification settings - Fork 343
docs: improve onboarding for first-time contributors #679
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I do not think the changes here are meaningful/useful additions to the documentation |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,18 @@ Client side set up is straight forward and standard, i.e clone the repo [Resonte | |
|
|
||
| Please strictly stick to the guide do not go off installing stuff on your own | ||
|
|
||
| ## Quick Start for First-Time Contributors (Without Full Backend) | ||
|
|
||
| If you are a first-time contributor or GSoC aspirant, you do **not** need to set up the complete backend environment to start contributing. | ||
|
|
||
| You can begin by: | ||
| - Exploring the Flutter codebase (screens, controllers, routes, and UI) | ||
| - Reading documentation files like README.md, CONTRIBUTING.md, and ONBOARDING.md | ||
| - Running `flutter pub get` to understand dependencies | ||
| - Reporting build issues, documentation gaps, or UI inconsistencies | ||
|
||
|
|
||
| Backend setup (Appwrite, LiveKit, Meilisearch) is only required for contributors working on backend-dependent features. New contributors are encouraged to start small and gradually move to advanced areas. | ||
|
||
|
|
||
| > #### **Setting up Firebase for FCM** | ||
| > To ensure that new contributors do not have to setup firebase projects, all Firebase functionality (Only used for Notifications via FCM) has been disabled in the application. To enable this functionality (if you want to test notifications), setup a project on firebase, configure Resonate to use your project using this [guide](https://firebase.google.com/docs/flutter/setup) and uncomment the Firebase and FCM specific code in the files: ```main.dart , auth_state_controller.dart, and upcomming_rooms_controller.dart ``` Also, in the [Resonate Backend Repo](https://github.com/AOSSIE-Org/Resonate-Backend), uncomment the FCM and Firebase code in the `Upcoming Rooms Time Checker Function` and add your google-services.json in the folder for that function before setting up the localhost backend. | ||
| <br/> | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -45,7 +45,7 @@ With social voice platforms like Spotify, Clubhouse, and Twitter Spaces experien | |||||||||
| 1. Real-time Audio Communication by joining rooms and talking to people. | ||||||||||
| 2. Ability to create rooms and moderate speakers and events. | ||||||||||
| 3. Create Scheduled Rooms and notify subscribers as reminders to join | ||||||||||
| 4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favourate creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progess) | ||||||||||
| 4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress) | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix grammatical issue in feature description. The phrase "Listen to and Stories as chapters..." is grammatically incomplete. It should likely read "Listen to Stories as chapters..." or similar. 🔎 Suggested correction-4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)
+4. Listen to Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)Alternatively, if "and" was intended to connect two actions: -4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)
+4. Create and listen to Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)📝 Committable suggestion
Suggested change
Suggested change
🤖 Prompt for AI Agents |
||||||||||
| 5. Pair chatting to enable users to find random partners to talk to in the app. | ||||||||||
| 6. Friend People/Profiles enabling your self to talk on voice calls/realtime messaging with them (coming soon) | ||||||||||
|
|
||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything declared in this section already exists above
Line 28
Line 26
Line 29-32
Line 33