Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,17 @@ Make sure to use conventional commit structure as follows:
```

Know more about Conventional Commits [here](https://www.conventionalcommits.org/en/v1.0.0/).

### First-Time Contributor Workflow

If you are new to open source or contributing to Resonate, follow these steps:

1. Fork the repository on GitHub
2. Clone your fork locally
3. Create a new branch from the `dev` branch
4. Make your changes (documentation, fixes, or improvements)
5. Commit your changes with a clear message
6. Push your branch to your fork
7. Open a Pull Request targeting the `dev` branch

If you are unsure about an issue, feel free to open a discussion or issue before starting.
Copy link
Contributor

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

  1. Fork the repository and create your branch.

Line 28

We welcome contributions in the form of pull requests only to the dev branch.

Line 26

  1. Make the necessary code changes or improvements in your branch.
  1. Ensure your code adheres to the project's coding style and guidelines.
  2. Document any relevant changes or updates in the project's documentation.
  3. Submit the pull request, providing a clear title and description of the changes made.

Line 29-32

  1. Engage in any feedback or discussions related to your pull request.

Line 33

12 changes: 12 additions & 0 deletions ONBOARDING.md
Copy link
Contributor

Choose a reason for hiding this comment

The 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
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These points are also conveyed in CONTRIBUTING.md directly/indirectly


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is factually untrue, the App will not run without setting up the Backend in some capacity


> #### **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/>
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
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)
Suggested change
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)
🤖 Prompt for AI Agents
In README.md around line 48, the feature sentence "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)" is grammatically
incorrect; replace the fragment "Listen to and Stories as chapters..." with a
corrected phrase such as "Listen to Stories as chapters with synced lyrics..."
(or if two actions were intended, change to "Listen to and read Stories as
chapters with synced lyrics..."), and then ensure the rest of the sentence reads
smoothly (e.g., "Browse the entire catalog of stories, follow your favorite
creators to get updates on new chapter/story releases, and post your own
multi-chapter stories. (work in progress)").

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)

Expand Down